@ogcio/building-blocks-sdk 0.0.7 → 0.0.8

package/.github/dependabot.yaml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      time: "23:00" # UTC time
+    open-pull-requests-limit: 1
+    groups:
+      all-dependencies:
+        patterns:
+          - "*"

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+npm run check:formatting
+npm run check:linting

package/README.md

@@ -47,6 +47,8 @@ Access to building-blocks api is granted through access token in the `Authorizat
 Users can pass the `getTokenFn` function to the SDK. The SDK client will call this function when it needs an access token. The SDK will provide the service name of the service for which it is requesting the token:
 
 ```typescript
+import getBuildingBlockSDK from "@ogcio/building-blocks-sdk";
+
 const sdk = getBuildingBlockSDK({
   services: {
     upload: {
@@ -74,6 +76,8 @@ npm i @logto/node
 and use the `getM2MTokenFn` utility function. This function accepts the M2M configuration parameters for each of the building-blocks api and returns a `getTokenFn` compliant function that will handle Logto m2m retrieval for you:
 
 ```typescript
+import getBuildingBlockSDK, { getM2MTokenFn } from "@ogcio/building-blocks-sdk";
+
 const sdk = getBuildingBlockSDK({
   services: {
     upload: {
@@ -98,6 +102,8 @@ const sdk = getBuildingBlockSDK({
 Using the m2m utility function like this will cause the SDK to request all the scopes available for the building-block, scopes can be overridden when passed as parameter:
 
 ```typescript
+import getBuildingBlockSDK, { getM2MTokenFn } from "@ogcio/building-blocks-sdk";
+
 const sdk = getBuildingBlockSDK({
   services: {
     upload: {
@@ -128,8 +134,6 @@ This project is built with the latest Node LTS, clone this repository and instal
 npm install
 ```
 
-The code is formatted and linted with [biome](https://biomejs.dev/).
-
 The clients schemas are auto generated using open `openapi-typescript`.
 
 you can update the json configuration clients for each client under: `src/clients-configuration/clients-configuration.json`,
@@ -140,3 +144,21 @@ npm run clients:update
 ```
 
 to update the schemas. At this point you are ready to modify clients files and use the newly generated schemas
+
+### Formatting and linting
+
+The code is formatted and linted with [biome](https://biomejs.dev/). If you use `VS Code` you can install the `biome` extension to get suggestions and auto-fix on save ( Ref: https://biomejs.dev/guides/editors/first-party-extensions/)
+
+To check the formatting and linting errors run:
+
+```bash
+npm run check:formatting
+npm run check:linting
+```
+
+To fix the formatting and linting errors run:
+
+```bash
+npm run fix:formatting
+npm run fix:linting
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ogcio/building-blocks-sdk",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -8,9 +8,15 @@
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "rm -rf dist && tsc -p tsconfig.prod.json",
     "clients:update": "node --import=tsx src/cli/index.ts clients:update -c src/clients-configurations/clients-configuration.json",
-    "clients:outdated": "node --import=tsx src/cli/index.ts clients:outdated -c src/clients-configurations/clients-configuration.json"
+    "clients:outdated": "node --import=tsx src/cli/index.ts clients:outdated -c src/clients-configurations/clients-configuration.json",
+    "check:formatting": "biome format",
+    "fix:formatting": "biome format --write",
+    "check:linting": "biome lint",
+    "fix:linting": "biome lint --write",
+    "prepare": "husky || true"
   },
   "dependencies": {
+    "@ogcio/analytics-sdk": "0.0.1-beta.1",
     "@sinclair/typebox": "^0.33.15",
     "commander": "^12.1.0",
     "http-errors": "^2.0.0",

package/src/client/auth/index.ts

@@ -89,7 +89,9 @@ const importUserScopes = async () => {
   }
 };
 
-const getM2MTokenFn = (m2mTokenConfig: M2MTokenFnConfig): TokenFunction => {
+export const getM2MTokenFn = (
+  m2mTokenConfig: M2MTokenFnConfig,
+): TokenFunction => {
   const { services } = m2mTokenConfig;
 
   const tokenFn = (serviceName: SERVICE_NAME) => {
@@ -127,5 +129,3 @@ const getM2MTokenFn = (m2mTokenConfig: M2MTokenFnConfig): TokenFunction => {
   };
   return tokenFn;
 };
-
-export default getM2MTokenFn;

package/src/client/base-client.ts

@@ -3,7 +3,7 @@ import createClient, {
   type FetchResponse,
 } from "openapi-fetch";
 import type {
-  ApiClientParams,
+  BaseApiClientParams,
   SERVICE_NAME,
   TokenFunction,
 } from "../types/index.js";
@@ -19,7 +19,7 @@ abstract class BaseClient<T extends {}> {
 
   protected client: ReturnType<typeof createClient<T>>;
 
-  constructor({ baseUrl, getTokenFn }: ApiClientParams) {
+  constructor({ baseUrl, getTokenFn }: BaseApiClientParams) {
     this.initialized = false;
     if (baseUrl) {
       this.baseUrl = baseUrl;
@@ -48,6 +48,10 @@ abstract class BaseClient<T extends {}> {
     this.client.use(authMiddleware);
   }
 
+  public deleteToken() {
+    this.token = undefined;
+  }
+
   protected async getToken() {
     if (this.getTokenFn) {
       const token = await this.getTokenFn(this.serviceName as SERVICE_NAME);

package/src/client/clients/messaging/index.ts

@@ -10,7 +10,7 @@ import {
 import type { paths } from "./schema.js";
 
 class Messaging extends BaseClient<paths> {
-  declare client: ReturnType<typeof createClient<paths>>;
+  protected declare client: ReturnType<typeof createClient<paths>>;
   protected serviceName = MESSAGING;
 
   async getMessagesForUser(

package/src/client/clients/payments/index.ts

@@ -4,7 +4,7 @@ import BaseClient from "../../base-client.js";
 import type { paths } from "./schema.js";
 
 class Payments extends BaseClient<paths> {
-  declare client: ReturnType<typeof createClient<paths>>;
+  protected declare client: ReturnType<typeof createClient<paths>>;
   protected serviceName = PAYMENTS;
 
   /**
@@ -344,6 +344,23 @@ class Payments extends BaseClient<paths> {
       (reason) => this.formatError(reason),
     );
   }
+
+  async getRedirectToken(
+    transactionId: paths["/api/v1/transactions/{transactionId}/token"]["get"]["parameters"]["path"]["transactionId"],
+  ) {
+    return this.client
+      .GET("/api/v1/transactions/{transactionId}/token", {
+        params: {
+          path: {
+            transactionId,
+          },
+        },
+      })
+      .then(
+        (response) => this.formatResponse(response),
+        (reason) => this.formatError(reason),
+      );
+  }
 }
 
 export default Payments;

package/src/client/clients/profile/index.ts

@@ -4,7 +4,7 @@ import BaseClient from "../../base-client.js";
 import type { paths } from "./schema.js";
 
 class Profile extends BaseClient<paths> {
-  declare client: ReturnType<typeof createClient<paths>>;
+  protected declare client: ReturnType<typeof createClient<paths>>;
   protected serviceName = PROFILE;
 
   async getAddresses() {

package/src/client/clients/scheduler/index.ts

@@ -4,7 +4,7 @@ import BaseClient from "../../base-client.js";
 import type { paths } from "./schema.js";
 
 class Scheduler extends BaseClient<paths> {
-  declare client: ReturnType<typeof createClient<paths>>;
+  protected declare client: ReturnType<typeof createClient<paths>>;
   protected serviceName = SCHEDULER;
 
   async scheduleTasks(

package/src/client/clients/upload/index.ts

@@ -4,15 +4,22 @@ import BaseClient from "../../base-client.js";
 import type { paths } from "./schema.js";
 
 class Upload extends BaseClient<paths> {
-  declare client: ReturnType<typeof createClient<paths>>;
+  protected declare client: ReturnType<typeof createClient<paths>>;
   protected serviceName = UPLOAD;
 
-  getFilesMetadata(organizationId: string) {
+  getFilesMetadata({
+    organizationId,
+    userId,
+  }: {
+    organizationId?: string;
+    userId?: string;
+  }) {
     return this.client
       .GET("/api/v1/metadata/", {
         params: {
           query: {
             organizationId,
+            userId,
           },
         },
       })
@@ -22,28 +29,6 @@ class Upload extends BaseClient<paths> {
       );
   }
 
-  shareFile(fileId: string, userId: string) {
-    return this.client
-      .POST("/api/v1/permissions/", {
-        body: { fileId, userId },
-      })
-      .then(
-        (response) => this.formatResponse(response),
-        (reason) => this.formatError(reason),
-      );
-  }
-
-  removeFileSharing(fileId: string, userId: string) {
-    return this.client
-      .DELETE("/api/v1/permissions/", {
-        body: { fileId, userId },
-      })
-      .then(
-        (response) => this.formatResponse(response),
-        (reason) => this.formatError(reason),
-      );
-  }
-
   async getFile(id: string) {
     try {
       const {
@@ -104,6 +89,43 @@ class Upload extends BaseClient<paths> {
       );
   }
 
+  getFileSharings(id: string) {
+    return this.client
+      .GET("/api/v1/permissions/", {
+        params: {
+          query: {
+            fileId: id,
+          },
+        },
+      })
+      .then(
+        (response) => this.formatResponse(response),
+        (reason) => this.formatError(reason),
+      );
+  }
+
+  shareFile(fileId: string, userId: string) {
+    return this.client
+      .POST("/api/v1/permissions/", {
+        body: { fileId, userId },
+      })
+      .then(
+        (response) => this.formatResponse(response),
+        (reason) => this.formatError(reason),
+      );
+  }
+
+  removeFileSharing(fileId: string, userId: string) {
+    return this.client
+      .DELETE("/api/v1/permissions/", {
+        body: { fileId, userId },
+      })
+      .then(
+        (response) => this.formatResponse(response),
+        (reason) => this.formatError(reason),
+      );
+  }
+
   async uploadFile(file: File, expirationDate?: string) {
     const { error } = await this.client.POST("/api/v1/files/", {
       body: {

package/src/clients-configurations/clients-configuration.json

@@ -1,5 +1,13 @@
 {
   "buildingBlocks": [
+    {
+      "name": "analytics",
+      "openApiDefinitionUrl": "",
+      "openApiDefinitionFormat": "yaml",
+      "updateDefinitions": false,
+      "citizenPermissions": [],
+      "publicServantPermissions": []
+    },
     {
       "name": "messaging",
       "openApiDefinitionUrl": "https://raw.githubusercontent.com/ogcio/life-events/refs/heads/dev/apps/messaging-api/openapi-definition.yml",

package/src/index.ts

@@ -1,15 +1,17 @@
+import { Analytics } from "@ogcio/analytics-sdk";
+
 import Messaging from "./client/clients/messaging/index.js";
 import Payments from "./client/clients/payments/index.js";
 import Profile from "./client/clients/profile/index.js";
 import Scheduler from "./client/clients/scheduler/index.js";
 import Upload from "./client/clients/upload/index.js";
-
 export type { BuildingBlocksSDK } from "./types/index.js";
-export { default as getM2MTokenFn } from "./client/auth/index.js";
+export { getM2MTokenFn } from "./client/auth/index.js";
 
 import type {
   BuildingBlockSDKParams,
   BuildingBlocksSDK,
+  TokenFunction,
 } from "./types/index.js";
 
 const getBuildingBlockSDK = (
@@ -17,6 +19,10 @@ const getBuildingBlockSDK = (
 ): BuildingBlocksSDK => {
   const { services, getTokenFn } = params;
   return {
+    analytics: new Analytics({
+      ...services.analytics,
+      getTokenFn,
+    }),
     messaging: new Messaging({
       ...services.messaging,
       getTokenFn,
@@ -26,7 +32,7 @@ const getBuildingBlockSDK = (
       getTokenFn,
     }),
     profile: new Profile({
-      ...services.payments,
+      ...services.profile,
       getTokenFn,
     }),
     scheduler: new Scheduler({

package/src/types/index.ts

@@ -1,9 +1,11 @@
+import type { Analytics } from "@ogcio/analytics-sdk";
 import type Messaging from "../client/clients/messaging/index.js";
 import type Payments from "../client/clients/payments/index.js";
 import type Profile from "../client/clients/profile/index.js";
 import type Scheduler from "../client/clients/scheduler/index.js";
 import type Upload from "../client/clients/upload/index.js";
 
+export const ANALYTICS = "analytics" as const;
 export const MESSAGING = "messaging" as const;
 export const PAYMENTS = "payments" as const;
 export const PROFILE = "profile" as const;
@@ -11,6 +13,7 @@ export const SCHEDULER = "scheduler" as const;
 export const UPLOAD = "upload" as const;
 
 export type SERVICE_NAME =
+  | typeof ANALYTICS
   | typeof MESSAGING
   | typeof PAYMENTS
   | typeof PROFILE
@@ -36,25 +39,28 @@ export type SDKClientParams = {
   baseUrl?: string;
 };
 
-export type ApiClientParams = SDKClientParams & {
+export type BaseApiClientParams = SDKClientParams & {
   getTokenFn?: TokenFunction;
 };
 
 type ServiceClients = {
-  messaging: Messaging;
-  payments: Payments;
-  profile: Profile;
-  scheduler: Scheduler;
-  upload: Upload;
+  analytics: typeof Analytics;
+  messaging: typeof Messaging;
+  payments: typeof Payments;
+  profile: typeof Profile;
+  scheduler: typeof Scheduler;
+  upload: typeof Upload;
 };
 
 export type BuildingBlocksSDK = {
-  [key in keyof ServiceClients]: ServiceClients[key];
+  [key in keyof ServiceClients]: InstanceType<ServiceClients[key]>;
 };
 
 export type BuildingBlockSDKParams = {
   services: {
-    [key in keyof ServiceClients]?: SDKClientParams;
+    [key in keyof ServiceClients]?: ConstructorParameters<
+      ServiceClients[key]
+    >[0];
   };
   getTokenFn?: TokenFunction;
 };