@tanglemedia/svelte-starter-directus-api 7.0.0 → 8.1.0

package/src/provider/api-references-functions.provider.ts

@@ -1 +1,263 @@
-export * from '@directus/sdk';
+// Client setup
+export { authentication, createDirectus, memoryStorage, rest, staticToken } from '@directus/sdk';
+
+// Auth commands
+export {
+	login,
+	logout,
+	passwordRequest,
+	passwordReset,
+	readProviders,
+	refresh,
+} from '@directus/sdk';
+
+// Create commands
+export {
+	createCollection,
+	createComment,
+	createComments,
+	createContentVersion,
+	createContentVersions,
+	createDashboard,
+	createDashboards,
+	createField,
+	createFlow,
+	createFlows,
+	createFolder,
+	createFolders,
+	createItem,
+	createItems,
+	createNotification,
+	createNotifications,
+	createOperation,
+	createOperations,
+	createPanel,
+	createPanels,
+	createPermission,
+	createPermissions,
+	createPolicies,
+	createPolicy,
+	createPreset,
+	createPresets,
+	createRelation,
+	createRole,
+	createRoles,
+	createShare,
+	createShares,
+	createTranslation,
+	createTranslations,
+	createUser,
+	createUsers,
+	importFile,
+	uploadFiles,
+} from '@directus/sdk';
+
+// Read commands
+export {
+	aggregate,
+	downloadFilesZip,
+	downloadFolderZip,
+	readActivities,
+	readActivity,
+	readAssetArrayBuffer,
+	readAssetBlob,
+	readAssetRaw,
+	readCollection,
+	readCollections,
+	readComment,
+	readComments,
+	readContentVersion,
+	readContentVersions,
+	readDashboard,
+	readDashboards,
+	readExtensions,
+	readField,
+	readFields,
+	readFieldsByCollection,
+	readFile,
+	readFiles,
+	readFlow,
+	readFlows,
+	readFolder,
+	readFolders,
+	readGraphqlSdl,
+	readItem,
+	readItemPermissions,
+	readItems,
+	readMe,
+	readNotification,
+	readNotifications,
+	readOpenApiSpec,
+	readOperation,
+	readOperations,
+	readPanel,
+	readPanels,
+	readPermission,
+	readPermissions,
+	readPolicies,
+	readPolicy,
+	readPolicyGlobals,
+	readPreset,
+	readPresets,
+	readRelation,
+	readRelationByCollection,
+	readRelations,
+	readRevision,
+	readRevisions,
+	readRole,
+	readRoles,
+	readRolesMe,
+	readSettings,
+	readShare,
+	readShareInfo,
+	readShares,
+	readSingleton,
+	readTranslation,
+	readTranslations,
+	readUser,
+	readUserPermissions,
+	readUsers,
+} from '@directus/sdk';
+
+// Update commands
+export {
+	updateCollection,
+	updateCollectionsBatch,
+	updateComment,
+	updateComments,
+	updateCommentsBatch,
+	updateContentVersion,
+	updateContentVersions,
+	updateContentVersionsBatch,
+	updateDashboard,
+	updateDashboards,
+	updateDashboardsBatch,
+	updateExtension,
+	updateField,
+	updateFields,
+	updateFile,
+	updateFiles,
+	updateFilesBatch,
+	updateFlow,
+	updateFlows,
+	updateFlowsBatch,
+	updateFolder,
+	updateFolders,
+	updateFoldersBatch,
+	updateItem,
+	updateItems,
+	updateItemsBatch,
+	updateMe,
+	updateNotification,
+	updateNotifications,
+	updateNotificationsBatch,
+	updateOperation,
+	updateOperations,
+	updateOperationsBatch,
+	updatePanel,
+	updatePanels,
+	updatePanelsBatch,
+	updatePermission,
+	updatePermissions,
+	updatePermissionsBatch,
+	updatePolicies,
+	updatePoliciesBatch,
+	updatePolicy,
+	updatePreset,
+	updatePresets,
+	updatePresetsBatch,
+	updateRelation,
+	updateRole,
+	updateRoles,
+	updateRolesBatch,
+	updateSettings,
+	updateShare,
+	updateShares,
+	updateSharesBatch,
+	updateSingleton,
+	updateTranslation,
+	updateTranslations,
+	updateTranslationsBatch,
+	updateUser,
+	updateUsers,
+	updateUsersBatch,
+} from '@directus/sdk';
+
+// Delete commands
+export {
+	deleteCollection,
+	deleteComment,
+	deleteComments,
+	deleteContentVersion,
+	deleteContentVersions,
+	deleteDashboard,
+	deleteDashboards,
+	deleteField,
+	deleteFile,
+	deleteFiles,
+	deleteFlow,
+	deleteFlows,
+	deleteFolder,
+	deleteFolders,
+	deleteItem,
+	deleteItems,
+	deleteNotification,
+	deleteNotifications,
+	deleteOperation,
+	deleteOperations,
+	deletePanel,
+	deletePanels,
+	deletePermission,
+	deletePermissions,
+	deletePolicies,
+	deletePolicy,
+	deletePreset,
+	deletePresets,
+	deleteRelation,
+	deleteRole,
+	deleteRoles,
+	deleteShare,
+	deleteShares,
+	deleteTranslation,
+	deleteTranslations,
+	deleteUser,
+	deleteUsers,
+} from '@directus/sdk';
+
+// Schema commands
+export { schemaApply, schemaDiff, schemaSnapshot } from '@directus/sdk';
+
+// Server commands
+export { serverHealth, serverInfo, serverPing } from '@directus/sdk';
+
+// Utility functions
+export {
+	acceptUserInvite,
+	authenticateShare,
+	clearCache,
+	compareContentVersion,
+	customEndpoint,
+	disableTwoFactor,
+	enableTwoFactor,
+	generateHash,
+	generateTwoFactorSecret,
+	inviteShare,
+	inviteUser,
+	isDirectusError,
+	promoteContentVersion,
+	randomString,
+	registerUser,
+	registerUserVerify,
+	saveToContentVersion,
+	triggerFlow,
+	utilitySort,
+	utilsExport,
+	utilsImport,
+	verifyHash,
+	withOptions,
+	withSearch,
+	withToken,
+} from '@directus/sdk';
+
+// Types
+export type { DirectusClient, RestClient, RestCommand } from '@directus/sdk';

package/src/provider/directus.factory.ts

@@ -8,7 +8,7 @@ import {
   type ClientOptions
 } from '@directus/sdk';
 import { AuthLocalStorage } from '../storage/local-storage';
-import type { DirectusConfig } from '../types/adapter.types';
+import type { DirectusAdapterClient, DirectusConfig, SchemaShape } from '../types/adapter.types';
 
 const authConfigDefaults = {
   autoRefresh: false,
@@ -19,13 +19,13 @@ const authConfigDefaults = {
 /**
  * Creates a directus client based on the application configuration
  */
-export const createDirectusClientFactory = <T extends object>(
+export const createDirectusClientFactory = <T extends SchemaShape>(
   {
     baseUrl,
     configuration: { protocol = 'https', host, auth, staticToken: token, graphql: gql, rest: rs }
   }: DirectusConfig,
   options?: ClientOptions
-) => {
+): DirectusAdapterClient<T> => {
   let url = baseUrl;
 
   if (host) {
@@ -42,7 +42,7 @@ export const createDirectusClientFactory = <T extends object>(
     rs = { credentials: 'include' };
   }
 
-  let client = createDirectus<T>(url, options).with(rest(rs));
+  let client = createDirectus<T>(url, options).with(rest(rs)) as DirectusAdapterClient<T>;
 
   if (auth) {
     const { config: c, mode } = auth;
@@ -54,15 +54,15 @@ export const createDirectusClientFactory = <T extends object>(
       authConfig.storage = new AuthLocalStorage();
     }
 
-    client = client.with(authentication(mode, authConfig));
+    client = client.with(authentication(mode, authConfig)) as DirectusAdapterClient<T>;
   }
 
   if (token) {
-    client = client.with(staticToken(token));
+    client = client.with(staticToken(token)) as DirectusAdapterClient<T>;
   }
 
   if (gql) {
-    client = client.with(graphql(gql));
+    client = client.with(graphql(gql)) as DirectusAdapterClient<T>;
   }
 
   return client;

package/src/services/auth.ts

@@ -1,12 +1,23 @@
-import type { AuthenticationClient, DirectusClient, RestClient } from '@directus/sdk';
 import { readFiles, readMe, updateMe } from '@directus/sdk';
 import { ServiceAbstract } from '@tanglemedia/svelte-starter-core';
+import type { DirectusAdapterClient, SchemaShape } from '../types';
+
+type AuthenticatedDirectusClient = DirectusAdapterClient<SchemaShape> &
+  Required<Pick<DirectusAdapterClient<SchemaShape>, 'refresh' | 'getToken' | 'login' | 'logout'>>;
 
 class DirectusAuthServices extends ServiceAbstract {
   public getDirectus() {
-    return this.getAdapterClient<
-      DirectusClient<object> & RestClient<object> & AuthenticationClient<object>
-    >();
+    return this.getAdapterClient<DirectusAdapterClient<SchemaShape>>();
+  }
+
+  private async getAuthenticatedDirectus(): Promise<AuthenticatedDirectusClient> {
+    const directus = await this.getDirectus();
+
+    if (!directus.refresh || !directus.getToken || !directus.login || !directus.logout) {
+      throw new Error('Directus client is missing authentication methods');
+    }
+
+    return directus as AuthenticatedDirectusClient;
   }
 
   // public getConfig<T extends object>(): DirectusClient<T> & RestClient<object> {
@@ -15,7 +26,7 @@ class DirectusAuthServices extends ServiceAbstract {
 
   public async refresh() {
     try {
-      const response = await (await this.getDirectus()).refresh();
+      const response = await (await this.getAuthenticatedDirectus()).refresh();
       return response;
     } catch (error) {
       console.error(`Error on directus sdk refresh() :`, error);
@@ -25,7 +36,7 @@ class DirectusAuthServices extends ServiceAbstract {
 
   public async getToken() {
     try {
-      const response = await (await this.getDirectus()).getToken();
+      const response = await (await this.getAuthenticatedDirectus()).getToken();
       return response;
     } catch (error) {
       console.error(`Error on directus sdk getToken() :`, error);
@@ -35,7 +46,7 @@ class DirectusAuthServices extends ServiceAbstract {
 
   public async login(email: string, password: string) {
     try {
-      const response = await (await this.getDirectus()).login(email, password);
+      const response = await (await this.getAuthenticatedDirectus()).login({ email, password });
       return response;
     } catch (error) {
       console.error(`Error on directus sdk login() :`, error);
@@ -45,7 +56,7 @@ class DirectusAuthServices extends ServiceAbstract {
 
   public async logout() {
     try {
-      const response = await (await this.getDirectus()).logout();
+      const response = await (await this.getAuthenticatedDirectus()).logout();
       return response;
     } catch (error) {
       console.error(`Error on directus sdk logout() :`, error);
@@ -56,9 +67,8 @@ class DirectusAuthServices extends ServiceAbstract {
   public async getCurrentUser<T>(fields: string[] | null = null): Promise<T> {
     try {
       if (!(await this.getToken())) await this.refresh();
-      const response = await (
-        await this.getDirectus()
-      ).request<T>(readMe({ fields: fields ? fields : ['*', 'roles.*'] }));
+      const queryFields = (fields ?? ['*', 'roles.*']) as never;
+      const response = await (await this.getDirectus()).request<T>(readMe({ fields: queryFields }));
       return response;
     } catch (error) {
       console.error(`Error on directus sdk readMe() :`, error);

package/src/services/register.ts

@@ -17,7 +17,7 @@ class DirectusStaticServices extends ServiceAdapterAbstract {
     try {
       await (await this.getDirectus()).request(createUser(data));
 
-      return { message: 'You have successfully registered your account', type: 'success' };
+      return { message: 'You have registered your account', type: 'success' };
     } catch (error) {
       console.error(`Error creating a user:`, error);
       throw error;

package/src/types/adapter.types.ts

@@ -1,15 +1,25 @@
-import type { AuthenticationMode, GraphqlConfig } from '@directus/sdk';
+import type {
+  AuthenticationClient,
+  AuthenticationMode,
+  DirectusClient,
+  GraphqlClient,
+  GraphqlConfig,
+  RestClient,
+  StaticTokenClient
+} from '@directus/sdk';
 import type { BaseApiAdapterConfig } from '@tanglemedia/svelte-starter-core';
 
-export {
-  type AllCollections,
-  type DirectusClient,
-  type RegularCollections,
-  type RestClient,
-  type StaticTokenClient,
-  type AuthenticationClient
+export type {
+  AllCollections,
+  RegularCollections,
+  DirectusClient,
+  RestClient,
+  StaticTokenClient,
+  AuthenticationClient
 } from '@directus/sdk';
 
+export type * from '@directus/types';
+
 export type DirectusApiAuthOptions = {
   mode: AuthenticationMode;
   config?: Partial<{
@@ -40,4 +50,11 @@ export type DirectusApiAdapterOptions = {
 
 export type DirectusConfig = BaseApiAdapterConfig<DirectusApiAdapterOptions>;
 
-export type SchemaShape = Record<string, object>;
+export type SchemaShape = Record<string, object | object[]>;
+
+export type DirectusAdapterClient<Schema extends SchemaShape = SchemaShape> =
+  DirectusClient<Schema> &
+  RestClient<Schema> &
+  Partial<AuthenticationClient<Schema>> &
+  Partial<StaticTokenClient<Schema>> &
+  Partial<GraphqlClient<Schema>>;

package/src/utils/directus-error.ts

@@ -0,0 +1,75 @@
+export type DirectusErrorCode =
+	| 'FAILED_VALIDATION'
+	| 'FORBIDDEN'
+	| 'INVALID_TOKEN'
+	| 'TOKEN_EXPIRED'
+	| 'INVALID_CREDENTIALS'
+	| 'INVALID_IP'
+	| 'INVALID_OTP'
+	| 'INVALID_PAYLOAD'
+	| 'INVALID_QUERY'
+	| 'UNSUPPORTED_MEDIA_TYPE'
+	| 'REQUESTS_EXCEEDED'
+	| 'ROUTE_NOT_FOUND'
+	| 'SERVICE_UNAVAILABLE'
+	| 'UNPROCESSABLE_CONTENT';
+
+type DirectusErrorExtensions = { code: string };
+
+type DirectusErrorEntry = {
+	message: string;
+	extensions: DirectusErrorExtensions;
+};
+
+type DirectusErrorShape = {
+	errors: DirectusErrorEntry[];
+};
+
+function parseDirectusErrorCandidate(err: unknown): unknown {
+	if (typeof err !== 'object' || err === null) {
+		return err;
+	}
+
+	if (isDirectusErrorShape(err)) {
+		return err;
+	}
+
+	if (!(err instanceof Error)) {
+		return err;
+	}
+
+	try {
+		return JSON.parse(err.message) as unknown;
+	} catch {
+		return err;
+	}
+}
+
+function isDirectusErrorShape(err: unknown): err is DirectusErrorShape {
+	if (typeof err !== 'object' || err === null) {
+		return false;
+	}
+	const candidate = err as Record<string, unknown>;
+	if (!Array.isArray(candidate['errors']) || candidate['errors'].length === 0) {
+		return false;
+	}
+	const first = candidate['errors'][0] as Record<string, unknown>;
+	return (
+		typeof first['extensions'] === 'object' &&
+		first['extensions'] !== null &&
+		'code' in (first['extensions'] as object)
+	);
+}
+
+/**
+ * Returns the Directus error code from the first error in a Directus API error response,
+ * or null if the value is not a Directus error shape.
+ */
+export function extractDirectusErrorCode(err: unknown): DirectusErrorCode | null {
+	const candidate = parseDirectusErrorCandidate(err);
+	if (!isDirectusErrorShape(candidate)) {
+		return null;
+	}
+	const code = (candidate.errors[0].extensions as DirectusErrorExtensions).code;
+	return (code as DirectusErrorCode) ?? null;
+}