fix: ship type definition on build package (#69)

resolve #67

CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## v0.3.2
+
+- No enhancements on packages
+
+[compare changes](https://github.com/ddradar/nuxt-swa/compare/v0.3.1...v0.3.2)
+
+### 🩹 Fixes
+
+- ship type definition on build package ([#69](https://github.com/ddradar/nuxt-swa/pull/69), resolve [#67](https://github.com/ddradar/nuxt-swa/issues/67))
+
+### 🏡 Chore
+
+- **lint:** Add eslint-plugin-simple-import ([#68](https://github.com/ddradar/nuxt-swa/pull/68))
+
+### ❤️ Contributors
+
+- Nogic
+
 ## v0.3.1
 
 - No enhancements on packages

docs/content/index.yml

@@ -6,8 +6,8 @@ hero:
   description: Provides Azure Static Web Apps features to your Nuxt apps.
   orientation: horizontal
   headline:
-    label: Released v0.3.0
-    to: https://github.com/ddradar/nuxt-swa/releases/tag/v0.3.0
+    label: Released v0.3.2
+    to: https://github.com/ddradar/nuxt-swa/releases/tag/v0.3.2
     icon: i-heroicons-rocket-launch-20-solid
   links:
     - label: Get started

docs/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-swa-docs",
   "private": true,
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Nuxt SWA module documentation and playground",
   "type": "module",
   "engines": {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-swa-monorepo",
   "private": true,
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Nuxt 3 module for Azure Static Web Apps",
   "repository": "ddradar/nuxt-swa",
   "license": "MIT",

packages/nuxt-swa/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-swa",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Nuxt module for Azure Static Web Apps",
   "repository": {
     "type": "git",
@@ -35,7 +35,6 @@
   },
   "dependencies": {
     "@nuxt/kit": "^3.10.3",
-    "consola": "^3.2.3",
     "defu": "^6.1.4",
     "ufo": "^1.4.0"
   },

packages/nuxt-swa/src/runtime/composables/useDataApi.ts

@@ -1,22 +1,26 @@
 import type { $Fetch } from 'nitropack'
 import type { FetchError } from 'ofetch'
 import { joinURL } from 'ufo'
-import type { MaybeRef } from 'vue'
+import { computed, type MaybeRef, toRef } from 'vue'
 
-import type { UseFetchOptions } from '#app'
+import {
+  type AsyncData,
+  useFetch,
+  type UseFetchOptions,
+  useRuntimeConfig,
+} from '#app'
 
 /**
  * Use Azure Static Web Apps Data API Feature (preview).
  * @returns `$fetch` object pre-configured for Data API
  */
-export function useDataApi(): {
+export const useDataApi = (): {
   /** `$fetch` object pre-configured for GraphQL API */
   $graphql: $Fetch
   /** `$fetch` object pre-configured for REST API */
   $rest: $Fetch
-} {
+} => {
   const { graphql, rest } = useRuntimeConfig().public.swa
-  console.info(useRequestHeaders())
   return {
     $graphql: $fetch.create({ baseURL: graphql, method: 'POST' }),
     $rest: $fetch.create({ baseURL: rest }),
@@ -30,22 +34,24 @@ export function useDataApi(): {
  * @returns useFetch object
  * @see https://learn.microsoft.com/azure/data-api-builder/rest
  */
-export function useFetchRest<T>(
+export const useFetchRest = <
+  SchemaT,
+  DataT = SchemaT[],
+  PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
+  DefaultT = null,
+>(
   request: MaybeRef<string>,
-  opts?: Omit<UseFetchOptions<RestResult<T>, T[]>, 'transform'>
-): ReturnType<typeof useFetch<T[] | null>> {
+  opts?: UseFetchOptions<RestResult<SchemaT>, DataT, PickKeys, DefaultT>
+): AsyncData<PickFrom<DataT, PickKeys> | DefaultT, FetchError<any> | null> => {
   const endpoint = useRuntimeConfig().public.swa.rest
   const requestRef = toRef(request)
   const computedUrl = computed(() => joinURL(endpoint, requestRef.value))
   return useFetch(computedUrl, {
+    transform: (d: RestResult<SchemaT>) => d.value as DataT,
     ...opts,
-    transform: (d: RestResult<T>) => d.value,
   })
 }
 
-type KeysOf<T> = Array<
-  T extends T ? (keyof T extends string ? keyof T : never) : never
->
 /**
  * Use fetch from/to Azure Static Web Apps Data API (GraphQL).
  * @param key `useFetch` key
@@ -55,11 +61,11 @@ type KeysOf<T> = Array<
  * @returns` useFetch` object
  * @see https://learn.microsoft.com/azure/data-api-builder/graphql
  */
-export function useFetchGraphQL<
+export const useFetchGraphQL = <
   SchemaT,
   DataT = SchemaT,
   PickKeys extends KeysOf<DataT> = KeysOf<DataT>,
-  DefaultT = DataT,
+  DefaultT = null,
 >(
   key: string,
   query: string,
@@ -68,18 +74,7 @@ export function useFetchGraphQL<
     UseFetchOptions<GraphQLResult<SchemaT>, DataT, PickKeys, DefaultT>,
     'body' | 'key' | 'method'
   >
-): ReturnType<
-  typeof useFetch<
-    GraphQLResult<SchemaT>,
-    FetchError<any>,
-    string,
-    'post',
-    GraphQLResult<SchemaT>,
-    DataT,
-    PickKeys,
-    DefaultT
-  >
-> {
+): AsyncData<PickFrom<DataT, PickKeys> | DefaultT, FetchError<any> | null> => {
   const endpoint = useRuntimeConfig().public.swa.graphql
   const variablesRef = toRef(variables)
 
@@ -100,3 +95,19 @@ export function useFetchGraphQL<
     ...opts,
   })
 }
+
+/** Port from nuxt runtime */
+type KeysOf<T> = Array<
+  T extends T ? (keyof T extends string ? keyof T : never) : never
+>
+/** Port from nuxt runtime */
+type PickFrom<T, K extends Array<string>> =
+  T extends Array<any>
+    ? T
+    : T extends Record<string, any>
+      ? keyof T extends K[number]
+        ? T
+        : K[number] extends never
+          ? T
+          : Pick<T, K[number]>
+      : T

packages/nuxt-swa/src/runtime/composables/useEasyAuth.ts

@@ -8,46 +8,17 @@ import {
   _authDataKey,
   _clientPrincipalHeader,
 } from '../constants'
+import type { ClientPrincipal } from '../types'
 import { parseClientPrincipal } from '../utils/auth'
 
-interface Claim {
-  typ: string
-  val: string
-}
-/**
- * User-identifiable information to your app.
- * @see https://learn.microsoft.com/azure/static-web-apps/user-information?tabs=javascript#client-principal-data
- */
-export interface ClientPrincipal {
-  /** The name of the identity provider. */
-  identityProvider: IdentityProvider
-  /**
-   * An Azure Static Web Apps-specific unique identifier for the user.
-   * - The value is unique on a per-app basis. For instance, the same user returns a different `userId` value on a different Static Web Apps resource.
-   * - The value persists for the lifetime of a user. If you delete and add the same user back to the app, a new `userId` is generated.
-   */
-  userId: string
-  /**
-   * Username or email address of the user.
-   * Some providers return the user's email address, while others send the user handle.
-   */
-  userDetails: string
-  /** An array of the user's assigned roles. */
-  userRoles: UserRole[]
-  /**
-   * An array of claims returned by your custom authentication provider.
-   * Only accessible in the direct-access endpoint (/.auth/me).
-   */
-  claims?: Claim[]
-}
 /** return type of `/.auth/me` endpoint */
 type AuthMeResult = { clientPrincipal: ClientPrincipal | null }
 
 /**
  * Use authentication & authorization features provided by Azure Static Web Apps.
  * @see https://learn.microsoft.com/en-us/azure/static-web-apps/authentication-authorization
  */
-export async function useEasyAuth(): Promise<{
+export const useEasyAuth = async (): Promise<{
   /** Client Principal data */
   clientPrincipal: DeepReadonly<Ref<ClientPrincipal | null>>
   /** Returns user is logged in app or not. (shorthand of `!!clientPrincipal.value`) */
@@ -77,7 +48,7 @@ export async function useEasyAuth(): Promise<{
    * @see https://learn.microsoft.com/azure/static-web-apps/authentication-authorization#remove-personal-data
    */
   purge: (provider: IdentityProvider) => Promise<void>
-}> {
+}> => {
   const { data: _auth, refresh } = await useAsyncData<ClientPrincipal | null>(
     _authDataKey,
     async () => {

packages/nuxt-swa/src/runtime/constants.ts

@@ -1,5 +1,3 @@
-import { consola } from 'consola'
-
 // Azure Static Web Apps
 export const _authBasePath = '/.auth'
 export const _dataApiBasePath = '/data-api'
@@ -13,5 +11,4 @@ export const _knownIdentityProviders = [
 ] as const
 
 // My App
-export const logger = consola.withTag('nuxt-swa')
 export const _authDataKey = 'swa-principal'

packages/nuxt-swa/src/runtime/middleware/auth.ts

@@ -1,3 +1,5 @@
+import { defineNuxtRouteMiddleware } from '#app'
+
 export default defineNuxtRouteMiddleware(async to => {
   if (!to.meta.allowedRoles) return
 

packages/nuxt-swa/src/runtime/server/utils/swa-auth.ts

@@ -1,15 +1,15 @@
 import { getHeader, type H3Event } from 'h3'
 
-import type { ClientPrincipal } from '../../composables/useEasyAuth'
 import { _clientPrincipalHeader } from '../../constants'
+import type { ClientPrincipal } from '../../types'
 import { parseClientPrincipal } from '../../utils/auth'
 
 /**
  * Get user client principal data from request.
  * @param event H3Event
  * @returns Client Principal if parsed, otherwise null.
  */
-export function getClientPrincipal(event: H3Event): ClientPrincipal | null {
+export const getClientPrincipal = (event: H3Event): ClientPrincipal | null => {
   const header = getHeader(event, _clientPrincipalHeader)
   return parseClientPrincipal(header)
 }
@@ -20,10 +20,10 @@ export function getClientPrincipal(event: H3Event): ClientPrincipal | null {
  * @param roles User roles
  * @returns true if the user has any of the specified roles; false otherwise.
  */
-export function hasRole(
+export const hasRole = (
   event: H3Event,
   ...roles: Exclude<UserRole, 'anonymous'>[]
-): boolean {
+): boolean => {
   const auth = getClientPrincipal(event)
   return !!auth?.userRoles.some(s =>
     roles.includes(s as (typeof roles)[number])

packages/nuxt-swa/src/runtime/types.d.ts

@@ -0,0 +1,30 @@
+interface Claim {
+  typ: string
+  val: string
+}
+/**
+ * User-identifiable information to your app.
+ * @see https://learn.microsoft.com/azure/static-web-apps/user-information?tabs=javascript#client-principal-data
+ */
+export interface ClientPrincipal {
+  /** The name of the identity provider. */
+  identityProvider: IdentityProvider
+  /**
+   * An Azure Static Web Apps-specific unique identifier for the user.
+   * - The value is unique on a per-app basis. For instance, the same user returns a different `userId` value on a different Static Web Apps resource.
+   * - The value persists for the lifetime of a user. If you delete and add the same user back to the app, a new `userId` is generated.
+   */
+  userId: string
+  /**
+   * Username or email address of the user.
+   * Some providers return the user's email address, while others send the user handle.
+   */
+  userDetails: string
+  /** An array of the user's assigned roles. */
+  userRoles: UserRole[]
+  /**
+   * An array of claims returned by your custom authentication provider.
+   * Only accessible in the direct-access endpoint (/.auth/me).
+   */
+  claims?: Claim[]
+}

packages/nuxt-swa/src/runtime/types/nuxt-swa.meta.d.ts

@@ -1,10 +1,17 @@
 // Generated by nuxt-swa
+type SpecifiedRole = Exclude<UserRole, 'anonymous'>
+
 declare module '#app' {
   interface PageMeta {
     /** List of roles required to view this page */
-    allowedRoles?:
-      | Exclude<UserRole, 'anonymous'>
-      | Exclude<UserRole, 'anonymous'>[]
+    allowedRoles?: SpecifiedRole | SpecifiedRole[]
+  }
+}
+
+declare module 'vue-router' {
+  interface RouteMeta {
+    /** List of roles required to view this page */
+    allowedRoles?: SpecifiedRole | SpecifiedRole[]
   }
 }
 

packages/nuxt-swa/src/runtime/utils/auth.ts

@@ -1,4 +1,4 @@
-import type { ClientPrincipal } from '../composables/useEasyAuth'
+import type { ClientPrincipal } from '../types'
 
 export function parseClientPrincipal(
   header: string | null | undefined

packages/nuxt-swa/tsconfig.json

@@ -1,3 +1,4 @@
 {
-  "extends": "./.nuxt/tsconfig.json"
+  "extends": "./.nuxt/tsconfig.json",
+  "exclude": ["docs"]
 }