@tanglemedia/svelte-starter-directus-api 4.0.2 → 4.1.0

package/README.md

@@ -260,4 +260,5 @@ export const formsServiceClient = configureService<FormInterface>(Forms, {
   adapterKey: 'directus-client'
 });
 ```
+
 ### For mode demos and to check out all the components, please visit our [documentation website](https://tanglemedia-svelte-docs.netlify.app/docs/directus-api-package/functionality)

package/dist/adapter/api-adapter.js

@@ -47,7 +47,7 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
             aggregate: { [k]: f },
             query: {
                 ...(filter ? { filter } : {}),
-                ...(search ? { search } : {}),
+                ...(search ? { search } : {})
             }
         }));
         let total = 0;
@@ -92,7 +92,7 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         }
     }
     async find(collection, query) {
-        const response = await this.directus.request(readItems(collection, query));
+        const response = (await this.directus.request(readItems(collection, query)));
         const total = await this.includeTotals(collection, query);
         if (null === total) {
             return this.transformResponse({ data: response });
@@ -105,11 +105,13 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
         return this.transformResponse({ data });
     }
     async aggregate(collection, query) {
-        const { aggregate: aggregate_, ...rest } = (query || {});
+        const { aggregate: aggregate_, ...rest } = query || {};
         const data = await this.directus.request(aggregate(collection, {
-            aggregate: aggregate_ ? aggregate_ : {
-                count: 'id'
-            },
+            aggregate: aggregate_
+                ? aggregate_
+                : {
+                    count: 'id'
+                },
             query: rest
         }));
         return this.transformResponse({ data });
@@ -128,7 +130,7 @@ export class DirectusApiAdapter extends ApiAdapterAbstract {
     }
     async put(collection, key, payload) {
         if (key) {
-            const data = await this.directus.request(updateItem(collection, key, payload));
+            const data = (await this.directus.request(updateItem(collection, key, payload)));
             return this.transformResponse({ data }, 201);
         }
         else {

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export * from './provider/directus.factory';
 export * from './services/auth';
 export * from './services/register';
 export type * from './types';
+export * from './provider/api-references-functions.provider';

package/dist/index.js

@@ -2,3 +2,4 @@ export * from './provider/api-adapter.provider';
 export * from './provider/directus.factory';
 export * from './services/auth';
 export * from './services/register';
+export * from './provider/api-references-functions.provider';

package/dist/provider/api-references-functions.provider.d.ts

@@ -0,0 +1 @@
+export { readItem, readSingleton, readItems, createItem, createItems, updateItem, updateSingleton, updateItems, deleteItem, deleteItems, readAssetRaw, readFiles, readFile, uploadFiles, importFile, updateFile, updateFiles, deleteFile, deleteFiles, readActivities, readActivity, readCollections, readCollection, createCollection, updateCollection, deleteCollection, readComments, readComment, createComment, createComments, updateComment, updateComments, deleteComment, deleteComments, readContentVersions, readContentVersion, createContentVersion, createContentVersions, updateContentVersion, updateContentVersions, deleteContentVersion, deleteContentVersions, saveToContentVersion, compareContentVersion, promoteContentVersion, readDashboards, readDashboard, createDashboard, createDashboards, updateDashboard, updateDashboards, deleteDashboard, deleteDashboards, readExtensions, updateExtension, readFields, readFieldsByCollection, readField, createField, updateField, deleteField, readFlows, readFlow, createFlow, createFlows, updateFlow, updateFlows, deleteFlow, deleteFlows, triggerFlow, readFolders, readFolder, createFolder, createFolders, updateFolder, updateFolders, deleteFolder, deleteFolders, readNotifications, readNotification, createNotification, createNotifications, updateNotification, updateNotifications, deleteNotification, deleteNotifications, readOperations, readOperation, createOperation, createOperations, updateOperation, updateOperations, deleteOperation, deleteOperations, triggerOperation, readPanels, readPanel, createPanel, createPanels, updatePanel, updatePanels, deletePanel, deletePanels, readPermissions, readPermission, createPermission, createPermissions, updatePermission, updatePermissions, deletePermission, deletePermissions, readUserPermissions, readItemPermissions, readPolicies, readPolicy, createPolicy, createPolicies, updatePolicy, updatePolicies, deletePolicy, deletePolicies, readPresets, readPreset, createPreset, createPresets, updatePreset, updatePresets, deletePreset, deletePresets, readRelations, readRelationByCollection, readRelation, createRelation, updateRelation, deleteRelation, readRevisions, readRevision, readRoles, readRole, createRole, createRoles, updateRole, updateRoles, deleteRole, deleteRoles, schemaSnapshot, readOpenApiSpec, readGraphqlSdl, serverPing, serverInfo, serverHealth, readSettings, updateSettings, readShares, readShare, createShare, createShares, updateShare, updateShares, deleteShare, deleteShares, authenticateShare, inviteShare, readShareInfo, readTranslations, readTranslation, createTranslation, createTranslations, updateTranslation, updateTranslations, deleteTranslation, deleteTranslations, readUsers, readUser, readMe, updateMe, createUser, createUsers, updateUser, updateUsers, deleteUser, deleteUsers, registerUser, registerUserVerify, inviteUser, acceptUserInvite, generateTwoFactorSecret, enableTwoFactor, disableTwoFactor, randomString, generateHash, verifyHash, utilitySort, utilsImport, utilsExport, clearCache } from '@directus/sdk';

package/dist/provider/api-references-functions.provider.js

@@ -0,0 +1 @@
+export { readItem, readSingleton, readItems, createItem, createItems, updateItem, updateSingleton, updateItems, deleteItem, deleteItems, readAssetRaw, readFiles, readFile, uploadFiles, importFile, updateFile, updateFiles, deleteFile, deleteFiles, readActivities, readActivity, readCollections, readCollection, createCollection, updateCollection, deleteCollection, readComments, readComment, createComment, createComments, updateComment, updateComments, deleteComment, deleteComments, readContentVersions, readContentVersion, createContentVersion, createContentVersions, updateContentVersion, updateContentVersions, deleteContentVersion, deleteContentVersions, saveToContentVersion, compareContentVersion, promoteContentVersion, readDashboards, readDashboard, createDashboard, createDashboards, updateDashboard, updateDashboards, deleteDashboard, deleteDashboards, readExtensions, updateExtension, readFields, readFieldsByCollection, readField, createField, updateField, deleteField, readFlows, readFlow, createFlow, createFlows, updateFlow, updateFlows, deleteFlow, deleteFlows, triggerFlow, readFolders, readFolder, createFolder, createFolders, updateFolder, updateFolders, deleteFolder, deleteFolders, readNotifications, readNotification, createNotification, createNotifications, updateNotification, updateNotifications, deleteNotification, deleteNotifications, readOperations, readOperation, createOperation, createOperations, updateOperation, updateOperations, deleteOperation, deleteOperations, triggerOperation, readPanels, readPanel, createPanel, createPanels, updatePanel, updatePanels, deletePanel, deletePanels, readPermissions, readPermission, createPermission, createPermissions, updatePermission, updatePermissions, deletePermission, deletePermissions, readUserPermissions, readItemPermissions, readPolicies, readPolicy, createPolicy, createPolicies, updatePolicy, updatePolicies, deletePolicy, deletePolicies, readPresets, readPreset, createPreset, createPresets, updatePreset, updatePresets, deletePreset, deletePresets, readRelations, readRelationByCollection, readRelation, createRelation, updateRelation, deleteRelation, readRevisions, readRevision, readRoles, readRole, createRole, createRoles, updateRole, updateRoles, deleteRole, deleteRoles, schemaSnapshot, readOpenApiSpec, readGraphqlSdl, serverPing, serverInfo, serverHealth, readSettings, updateSettings, readShares, readShare, createShare, createShares, updateShare, updateShares, deleteShare, deleteShares, authenticateShare, inviteShare, readShareInfo, readTranslations, readTranslation, createTranslation, createTranslations, updateTranslation, updateTranslations, deleteTranslation, deleteTranslations, readUsers, readUser, readMe, updateMe, createUser, createUsers, updateUser, updateUsers, deleteUser, deleteUsers, registerUser, registerUserVerify, inviteUser, acceptUserInvite, generateTwoFactorSecret, enableTwoFactor, disableTwoFactor, randomString, generateHash, verifyHash, utilitySort, utilsImport, utilsExport, clearCache } from '@directus/sdk';

package/dist/types/adapter.types.d.ts

@@ -1,5 +1,6 @@
 import type { AuthenticationMode, GraphqlConfig } from '@directus/sdk';
 import type { BaseApiAdapterConfig } from '@tanglemedia/svelte-starter-core';
+export { type AllCollections, type DirectusClient, type RegularCollections, type RestClient } from '@directus/sdk';
 export type DirectusApiAuthOptions = {
     mode: AuthenticationMode;
     config?: Partial<{

package/dist/types/adapter.types.js

@@ -1 +1 @@
-export {};
+export {} from '@directus/sdk';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanglemedia/svelte-starter-directus-api",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "main": "src/index.ts",
   "types": "src/index.ts",
   "description": "directus API wrapper for all the directus sdk functionality",
@@ -22,7 +22,7 @@
     }
   },
   "devDependencies": {
-    "@directus/types": "^12.1.0",
+    "@directus/types": "12.2.2",
     "@sveltejs/adapter-auto": "^3.2.5",
     "@sveltejs/package": "^2.3.5",
     "@sveltejs/vite-plugin-svelte": "^3.1.2",
@@ -39,7 +39,7 @@
     "@tanglemedia/svelte-starter-core": "0.5.0"
   },
   "dependencies": {
-    "@directus/sdk": "^17.0.2",
+    "@directus/sdk": "18.0.1",
     "@types/js-cookie": "^3.0.6",
     "esm-env": "^1.0.0",
     "js-cookie": "^3.0.5"

package/src/adapter/api-adapter.ts

@@ -35,13 +35,16 @@ export type AdapterClient<Schema extends SchemaShape = SchemaShape> = DirectusCl
   RestClient<Schema>;
 
 /**
- * TODO: Various types fixes. The current adapter doesn't correctly follow the types defined under the ApiAdapterAbstract. 
+ * TODO: Various types fixes. The current adapter doesn't correctly follow the types defined under the ApiAdapterAbstract.
  * See the fetch adapter under the core
  */
 export class DirectusApiAdapter<
-  Schema extends SchemaShape = SchemaShape,
-  Path extends RegularCollections<Schema> = RegularCollections<Schema>
-> extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient> implements ApiAdapterHandle {
+    Schema extends SchemaShape = SchemaShape,
+    Path extends RegularCollections<Schema> = RegularCollections<Schema>
+  >
+  extends ApiAdapterAbstract<DirectusConfig, ApiAdapterRequestConfig, Path, AdapterClient>
+  implements ApiAdapterHandle
+{
   constructor(
     protected config: DirectusConfig,
     private readonly directus: AdapterClient<Schema>
@@ -59,7 +62,8 @@ export class DirectusApiAdapter<
   }
 
   normalizeMeta(response: AnyObject) {
-    const payload = response.data, meta = response.meta as Record<string, unknown>;
+    const payload = response.data,
+      meta = response.meta as Record<string, unknown>;
 
     if (!meta) {
       return {};
@@ -91,13 +95,15 @@ export class DirectusApiAdapter<
     const k = this.config.configuration.totalAggregate || 'count';
     const f = this.config.configuration.totalField || 'id';
 
-    const data = await this.directus.request(aggregate(collection, {
-      aggregate: { [k]: f },
-      query: {
-        ...(filter ? { filter } : {}),
-        ...(search ? { search } : {}),
-      }
-    }));
+    const data = await this.directus.request(
+      aggregate(collection, {
+        aggregate: { [k]: f },
+        query: {
+          ...(filter ? { filter } : {}),
+          ...(search ? { search } : {})
+        }
+      })
+    );
 
     let total = 0;
 
@@ -110,7 +116,7 @@ export class DirectusApiAdapter<
   }
 
   async transformResponse<T, M extends object = AnyObject>(
-    res: { data: T, meta?: AnyObject },
+    res: { data: T; meta?: AnyObject },
     status: number = 200
   ): Promise<ApiResponse<T, Response, M>> {
     return {
@@ -157,8 +163,11 @@ export class DirectusApiAdapter<
     }
   }
 
-  public async find<T, Q = T, R = T>(collection: Path, query: ApiFindQuery<Q>): Promise<ApiResponse<R[]>> {
-    const response = await this.directus.request<T>(readItems(collection, query)) as R[];
+  public async find<T, Q = T, R = T>(
+    collection: Path,
+    query: ApiFindQuery<Q>
+  ): Promise<ApiResponse<R[]>> {
+    const response = (await this.directus.request<T>(readItems(collection, query))) as R[];
     const total = await this.includeTotals(collection, query);
     if (null === total) {
       return this.transformResponse({ data: response });
@@ -181,13 +190,15 @@ export class DirectusApiAdapter<
     collection: Path,
     query: ApiAggregateQuery<Q>
   ): Promise<ApiResponse<R>> {
-    const { aggregate: aggregate_, ...rest } = (query || {});
+    const { aggregate: aggregate_, ...rest } = query || {};
 
     const data = await this.directus.request<T>(
       aggregate(collection, {
-        aggregate: aggregate_ ? aggregate_ : {
-          count: 'id'
-        },
+        aggregate: aggregate_
+          ? aggregate_
+          : {
+              count: 'id'
+            },
         query: rest
       })
     );
@@ -218,9 +229,13 @@ export class DirectusApiAdapter<
     return this.transformResponse({ data }, 202);
   }
 
-  public async put<T extends object, R = T>(collection: Path, key?: ApiId, payload?: AnyObject): Promise<ApiResponse<R>> {
+  public async put<T extends object, R = T>(
+    collection: Path,
+    key?: ApiId,
+    payload?: AnyObject
+  ): Promise<ApiResponse<R>> {
     if (key) {
-      const data = await this.directus.request<T>(updateItem(collection, key, payload)) as R;
+      const data = (await this.directus.request<T>(updateItem(collection, key, payload))) as R;
       return this.transformResponse({ data }, 201);
     } else {
       console.error(`Error updating all ${collection}: no key specified`);

package/src/index.ts

@@ -5,3 +5,5 @@ export * from './services/auth';
 export * from './services/register';
 
 export type * from './types';
+
+export * from './provider/api-references-functions.provider';

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

@@ -0,0 +1,198 @@
+export {
+  readItem,
+  readSingleton,
+  readItems,
+  createItem,
+  createItems,
+  updateItem,
+  updateSingleton,
+  updateItems,
+  deleteItem,
+  deleteItems,
+  readAssetRaw,
+  readFiles,
+  readFile,
+  uploadFiles,
+  importFile,
+  updateFile,
+  updateFiles,
+  deleteFile,
+  deleteFiles,
+  readActivities,
+  readActivity,
+  readCollections,
+  readCollection,
+  createCollection,
+  updateCollection,
+  deleteCollection,
+  readComments,
+  readComment,
+  createComment,
+  createComments,
+  updateComment,
+  updateComments,
+  deleteComment,
+  deleteComments,
+  readContentVersions,
+  readContentVersion,
+  createContentVersion,
+  createContentVersions,
+  updateContentVersion,
+  updateContentVersions,
+  deleteContentVersion,
+  deleteContentVersions,
+  saveToContentVersion,
+  compareContentVersion,
+  promoteContentVersion,
+  readDashboards,
+  readDashboard,
+  createDashboard,
+  createDashboards,
+  updateDashboard,
+  updateDashboards,
+  deleteDashboard,
+  deleteDashboards,
+  readExtensions,
+  updateExtension,
+  readFields,
+  readFieldsByCollection,
+  readField,
+  createField,
+  updateField,
+  deleteField,
+  readFlows,
+  readFlow,
+  createFlow,
+  createFlows,
+  updateFlow,
+  updateFlows,
+  deleteFlow,
+  deleteFlows,
+  triggerFlow,
+  readFolders,
+  readFolder,
+  createFolder,
+  createFolders,
+  updateFolder,
+  updateFolders,
+  deleteFolder,
+  deleteFolders,
+  readNotifications,
+  readNotification,
+  createNotification,
+  createNotifications,
+  updateNotification,
+  updateNotifications,
+  deleteNotification,
+  deleteNotifications,
+  readOperations,
+  readOperation,
+  createOperation,
+  createOperations,
+  updateOperation,
+  updateOperations,
+  deleteOperation,
+  deleteOperations,
+  triggerOperation,
+  readPanels,
+  readPanel,
+  createPanel,
+  createPanels,
+  updatePanel,
+  updatePanels,
+  deletePanel,
+  deletePanels,
+  readPermissions,
+  readPermission,
+  createPermission,
+  createPermissions,
+  updatePermission,
+  updatePermissions,
+  deletePermission,
+  deletePermissions,
+  readUserPermissions,
+  readItemPermissions,
+  readPolicies,
+  readPolicy,
+  createPolicy,
+  createPolicies,
+  updatePolicy,
+  updatePolicies,
+  deletePolicy,
+  deletePolicies,
+  readPresets,
+  readPreset,
+  createPreset,
+  createPresets,
+  updatePreset,
+  updatePresets,
+  deletePreset,
+  deletePresets,
+  readRelations,
+  readRelationByCollection,
+  readRelation,
+  createRelation,
+  updateRelation,
+  deleteRelation,
+  readRevisions,
+  readRevision,
+  readRoles,
+  readRole,
+  createRole,
+  createRoles,
+  updateRole,
+  updateRoles,
+  deleteRole,
+  deleteRoles,
+  schemaSnapshot,
+  readOpenApiSpec,
+  readGraphqlSdl,
+  serverPing,
+  serverInfo,
+  serverHealth,
+  readSettings,
+  updateSettings,
+  readShares,
+  readShare,
+  createShare,
+  createShares,
+  updateShare,
+  updateShares,
+  deleteShare,
+  deleteShares,
+  authenticateShare,
+  inviteShare,
+  readShareInfo,
+  readTranslations,
+  readTranslation,
+  createTranslation,
+  createTranslations,
+  updateTranslation,
+  updateTranslations,
+  deleteTranslation,
+  deleteTranslations,
+  readUsers,
+  readUser,
+  readMe,
+  updateMe,
+  createUser,
+  createUsers,
+  updateUser,
+  updateUsers,
+  deleteUser,
+  deleteUsers,
+  registerUser,
+  registerUserVerify,
+  inviteUser,
+  acceptUserInvite,
+  generateTwoFactorSecret,
+  enableTwoFactor,
+  disableTwoFactor,
+  randomString,
+  generateHash,
+  verifyHash,
+  utilitySort,
+  utilsImport,
+  utilsExport,
+  clearCache
+} from '@directus/sdk';

package/src/types/adapter.types.ts

@@ -1,6 +1,13 @@
 import type { AuthenticationMode, GraphqlConfig } from '@directus/sdk';
 import type { BaseApiAdapterConfig } from '@tanglemedia/svelte-starter-core';
 
+export {
+  type AllCollections,
+  type DirectusClient,
+  type RegularCollections,
+  type RestClient
+} from '@directus/sdk';
+
 export type DirectusApiAuthOptions = {
   mode: AuthenticationMode;
   config?: Partial<{