@ogcio/building-blocks-sdk 0.0.1

package/dist/client/utils/client-utils.d.ts

@@ -0,0 +1,15 @@
+import type { ParseAsResponse } from "openapi-fetch";
+import type { ErrorStatus, FilterKeys, OkStatus, ResponseContent, ResponseObjectMap } from "openapi-typescript-helpers";
+export interface PaginationParams {
+    offset?: string | number;
+    limit?: string | number;
+}
+export type DataResponseValue<T, O> = ParseAsResponse<FilterKeys<ResponseContent<FilterKeys<ResponseObjectMap<T>, OkStatus>>, "application/json">, O> & {
+    error: ParseAsResponse<FilterKeys<ResponseContent<FilterKeys<ResponseObjectMap<T>, ErrorStatus>>, "application/json">, O>;
+};
+export declare function toStringOrUndefined(variable: number | boolean | undefined): string | undefined;
+export declare function preparePaginationParams(paginationParams?: PaginationParams): {
+    offset?: string;
+    limit?: string;
+};
+//# sourceMappingURL=client-utils.d.ts.map

package/dist/client/utils/client-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-utils.d.ts","sourceRoot":"","sources":["../../../src/client/utils/client-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,EACV,WAAW,EACX,UAAU,EACV,QAAQ,EACR,eAAe,EACf,iBAAiB,EAClB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,IAAI,eAAe,CACnD,UAAU,CACR,eAAe,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,EAC3D,kBAAkB,CACnB,EACD,CAAC,CACF,GAAG;IACF,KAAK,EAAE,eAAe,CACpB,UAAU,CACR,eAAe,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,EAC9D,kBAAkB,CACnB,EACD,CAAC,CACF,CAAC;CACH,CAAC;AAEF,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,sBAEzE;AAED,wBAAgB,uBAAuB,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG;IAC5E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAYA"}

package/dist/client/utils/client-utils.js

@@ -0,0 +1,14 @@
+export function toStringOrUndefined(variable) {
+    return variable === undefined ? undefined : String(variable);
+}
+export function preparePaginationParams(paginationParams) {
+    const output = {};
+    if (paginationParams?.offset) {
+        output.offset = String(paginationParams.offset);
+    }
+    if (paginationParams?.limit) {
+        output.limit = String(paginationParams.limit);
+    }
+    return output;
+}
+//# sourceMappingURL=client-utils.js.map

package/dist/client/utils/client-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-utils.js","sourceRoot":"","sources":["../../../src/client/utils/client-utils.ts"],"names":[],"mappings":"AA8BA,MAAM,UAAU,mBAAmB,CAAC,QAAsC;IACxE,OAAO,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,gBAAmC;IAIzE,MAAM,MAAM,GAAwC,EAAE,CAAC;IAEvD,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC7B,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,gBAAgB,EAAE,KAAK,EAAE,CAAC;QAC5B,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -0,0 +1,92 @@
+{
+    "buildingBlocks": [
+        {
+            "name": "messaging",
+            "openApiDefinitionUrl": "https://raw.githubusercontent.com/ogcio/life-events/refs/heads/dev/apps/messaging-api/openapi-definition.yml",
+            "openApiDefinitionFormat": "yaml",
+            "citizenPermissions": [
+                "messaging:message.self:read",
+                "messaging:message.self:write",
+                "messaging:citizen.self:read",
+                "messaging:citizen.self:write"
+            ],
+            "publicServantPermissions": [
+                "urn:logto:scope:organizations",
+                "urn:logto:scope:organization_roles",
+                "messaging:message:*",
+                "messaging:provider:*",
+                "messaging:template:*",
+                "messaging:citizen:*",
+                "messaging:event:read"
+            ],
+            "updateDefinitions": false
+        },
+        {
+            "name": "upload",
+            "openApiDefinitionUrl": "https://raw.githubusercontent.com/ogcio/life-events/refs/heads/dev/apps/upload-api/openapi-definition.yml",
+            "openApiDefinitionFormat": "yaml",
+            "citizenPermissions": ["upload:file.self:write", "upload:file.self:read"],
+            "publicServantPermissions": [
+                "urn:logto:scope:organizations",
+                "urn:logto:scope:organization_roles",
+                "upload:file:*",
+                "profile:user:read"
+            ],
+            "updateDefinitions": false
+        },
+        {
+            "name": "payments",
+            "openApiDefinitionUrl": "https://raw.githubusercontent.com/ogcio/life-events/refs/heads/dev/apps/payments-api/openapi-definition.yml",
+            "openApiDefinitionFormat": "yaml",
+            "citizenPermissions": [
+                "payments:transaction.self:read",
+                "payments:payment_request.public:read",
+                "payments:transaction.self:write",
+                "payments:provider.public:read"
+            ],
+            "publicServantPermissions": [
+                "urn:logto:scope:organizations",
+                "urn:logto:scope:organization_roles",
+                "payments:provider:*",
+                "payments:payment_request:*",
+                "payments:payment_request.public:read",
+                "payments:transaction:*"
+            ],
+            "updateDefinitions": false
+        },
+        {
+            "name": "scheduler",
+            "openApiDefinitionUrl": "https://raw.githubusercontent.com/ogcio/life-events/refs/heads/dev/apps/scheduler-api/openapi-definition.yml",
+            "openApiDefinitionFormat": "yaml",
+            "citizenPermissions": ["scheduler:jobs:write"],
+            "publicServantPermissions": [
+                "urn:logto:scope:organizations",
+                "urn:logto:scope:organization_roles",
+                "scheduler:jobs:write"
+            ],
+            "updateDefinitions": false
+        },
+        {
+            "name": "profile",
+            "openApiDefinitionUrl": "http://localhost:8003/docs/json",
+            "openApiDefinitionFormat": "json",
+            "citizenPermissions": [
+                "profile:user.self:read",
+                "profile:user.self:write",
+                "profile:address.self:read",
+                "profile:address.self:write",
+                "profile:entitlement.self:read",
+                "profile:entitlement.self:write",
+                "profile:user:read"
+            ],
+            "publicServantPermissions": [
+                "urn:logto:scope:organizations",
+                "urn:logto:scope:organization_roles",
+                "profile:user:*",
+                "profile:address:*",
+                "profile:entitlement:*"
+            ],
+            "updateDefinitions": true
+        }
+    ]
+}

package/dist/clients-configurations/read-configuration-file.d.ts

@@ -0,0 +1,22 @@
+import { type Static } from "@sinclair/typebox";
+export declare enum OpenAPIFileFormats {
+    JSON = "json",
+    YAML = "yaml"
+}
+declare const ConfigurationBuildingBlockSchema: import("@sinclair/typebox").TObject<{
+    name: import("@sinclair/typebox").TString;
+    openApiDefinitionUrl: import("@sinclair/typebox").TString;
+    openApiDefinitionFormat: import("@sinclair/typebox").TEnum<typeof OpenAPIFileFormats>;
+    citizenPermissions: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    publicServantPermissions: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    updateDefinitions: import("@sinclair/typebox").TBoolean;
+}>;
+export type ConfigurationBuildingBlock = Static<typeof ConfigurationBuildingBlockSchema>;
+type ConfigurationFile = {
+    buildingBlocks: {
+        [x: string]: ConfigurationBuildingBlock;
+    };
+};
+export declare function readConfigurationFile(configurationFilePath: string): Promise<ConfigurationFile>;
+export {};
+//# sourceMappingURL=read-configuration-file.d.ts.map

package/dist/clients-configurations/read-configuration-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-configuration-file.d.ts","sourceRoot":"","sources":["../../src/clients-configurations/read-configuration-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAQ,MAAM,mBAAmB,CAAC;AAGtD,oBAAY,kBAAkB;IAC5B,IAAI,SAAS;IACb,IAAI,SAAS;CACd;AAED,QAAA,MAAM,gCAAgC;;;;;;;EAOpC,CAAC;AAEH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAC7C,OAAO,gCAAgC,CACxC,CAAC;AAMF,KAAK,iBAAiB,GAAG;IACvB,cAAc,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,0BAA0B,CAAA;KAAE,CAAC;CAC7D,CAAC;AAcF,wBAAsB,qBAAqB,CACzC,qBAAqB,EAAE,MAAM,GAC5B,OAAO,CAAC,iBAAiB,CAAC,CAwB5B"}

package/dist/clients-configurations/read-configuration-file.js

@@ -0,0 +1,47 @@
+import { Type } from "@sinclair/typebox";
+import { Value } from "@sinclair/typebox/value";
+export var OpenAPIFileFormats;
+(function (OpenAPIFileFormats) {
+    OpenAPIFileFormats["JSON"] = "json";
+    OpenAPIFileFormats["YAML"] = "yaml";
+})(OpenAPIFileFormats || (OpenAPIFileFormats = {}));
+const ConfigurationBuildingBlockSchema = Type.Object({
+    name: Type.String(),
+    openApiDefinitionUrl: Type.String(),
+    openApiDefinitionFormat: Type.Enum(OpenAPIFileFormats),
+    citizenPermissions: Type.Array(Type.String(), { default: [] }),
+    publicServantPermissions: Type.Array(Type.String(), { default: [] }),
+    updateDefinitions: Type.Boolean({ default: true }),
+});
+const InputFileSchema = Type.Object({
+    buildingBlocks: Type.Array(ConfigurationBuildingBlockSchema),
+});
+function ensureBuildingBlockNameIsValid(bbName) {
+    // The building block name must only contain letters
+    // so its name can be used to get it using dot notation
+    // in code. E.g. sdkClient.messaging, where messaging
+    // is the name of the BB
+    const regex = /^[a-zA-Z]+$/g;
+    if (!regex.test(bbName))
+        throw new Error(`A building block name can only contain letters, ${bbName} is not valid`);
+}
+export async function readConfigurationFile(configurationFilePath) {
+    const { default: rawConfigurationFile } = await import(configurationFilePath, {
+        assert: {
+            type: "json",
+        },
+    });
+    const parsedFile = Value.Parse(InputFileSchema, rawConfigurationFile);
+    // Why do not directly create an object where the service name
+    // is the key in the configuration file instead of an array?
+    // To avoid having unexpected behaviours on naming
+    // e.g. Adding a "messaging-api" entry could return
+    // "messagingApi" when parsing
+    const outputFile = { buildingBlocks: {} };
+    for (const parsedBlock of parsedFile.buildingBlocks) {
+        ensureBuildingBlockNameIsValid(parsedBlock.name);
+        outputFile.buildingBlocks[parsedBlock.name] = parsedBlock;
+    }
+    return outputFile;
+}
+//# sourceMappingURL=read-configuration-file.js.map

package/dist/clients-configurations/read-configuration-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-configuration-file.js","sourceRoot":"","sources":["../../src/clients-configurations/read-configuration-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAEhD,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,mCAAa,CAAA;IACb,mCAAa,CAAA;AACf,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAED,MAAM,gCAAgC,GAAG,IAAI,CAAC,MAAM,CAAC;IACnD,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE;IACnB,oBAAoB,EAAE,IAAI,CAAC,MAAM,EAAE;IACnC,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC;IACtD,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IAC9D,wBAAwB,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACpE,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;CACnD,CAAC,CAAC;AAMH,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;IAClC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC;CAC7D,CAAC,CAAC;AAMH,SAAS,8BAA8B,CAAC,MAAc;IACpD,oDAAoD;IACpD,uDAAuD;IACvD,qDAAqD;IACrD,wBAAwB;IACxB,MAAM,KAAK,GAAG,cAAc,CAAC;IAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,mDAAmD,MAAM,eAAe,CACzE,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,qBAA6B;IAE7B,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CACpD,qBAAqB,EACrB;QACE,MAAM,EAAE;YACN,IAAI,EAAE,MAAM;SACb;KACF,CACF,CAAC;IAEF,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;IAEtE,8DAA8D;IAC9D,4DAA4D;IAC5D,kDAAkD;IAClD,mDAAmD;IACnD,8BAA8B;IAC9B,MAAM,UAAU,GAAsB,EAAE,cAAc,EAAE,EAAE,EAAE,CAAC;IAC7D,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;QACpD,8BAA8B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACjD,UAAU,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;IAC5D,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export type { BuildingBlocksSDK } from "./types/index.js";
+export { default as getM2MTokenFn } from "./client/auth/index.js";
+import type { BuildingBlockSDKParams, BuildingBlocksSDK } from "./types/index.js";
+declare const getBuildingBlockSDK: (params: BuildingBlockSDKParams) => BuildingBlocksSDK;
+export default getBuildingBlockSDK;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,YAAY,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAElE,OAAO,KAAK,EACV,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,kBAAkB,CAAC;AAE1B,QAAA,MAAM,mBAAmB,WACf,sBAAsB,KAC7B,iBAwBF,CAAC;AAEF,eAAe,mBAAmB,CAAC"}

package/dist/index.js

@@ -0,0 +1,33 @@
+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 { default as getM2MTokenFn } from "./client/auth/index.js";
+const getBuildingBlockSDK = (params) => {
+    const { services, getTokenFn } = params;
+    return {
+        messaging: new Messaging({
+            ...services.messaging,
+            getTokenFn,
+        }),
+        payments: new Payments({
+            ...services.payments,
+            getTokenFn,
+        }),
+        profile: new Profile({
+            ...services.payments,
+            getTokenFn,
+        }),
+        scheduler: new Scheduler({
+            ...services.scheduler,
+            getTokenFn,
+        }),
+        upload: new Upload({
+            ...services.upload,
+            getTokenFn,
+        }),
+    };
+};
+export default getBuildingBlockSDK;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,qCAAqC,CAAC;AAC5D,OAAO,QAAQ,MAAM,oCAAoC,CAAC;AAC1D,OAAO,OAAO,MAAM,mCAAmC,CAAC;AACxD,OAAO,SAAS,MAAM,qCAAqC,CAAC;AAC5D,OAAO,MAAM,MAAM,kCAAkC,CAAC;AAGtD,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAOlE,MAAM,mBAAmB,GAAG,CAC1B,MAA8B,EACX,EAAE;IACrB,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;IACxC,OAAO;QACL,SAAS,EAAE,IAAI,SAAS,CAAC;YACvB,GAAG,QAAQ,CAAC,SAAS;YACrB,UAAU;SACX,CAAC;QACF,QAAQ,EAAE,IAAI,QAAQ,CAAC;YACrB,GAAG,QAAQ,CAAC,QAAQ;YACpB,UAAU;SACX,CAAC;QACF,OAAO,EAAE,IAAI,OAAO,CAAC;YACnB,GAAG,QAAQ,CAAC,QAAQ;YACpB,UAAU;SACX,CAAC;QACF,SAAS,EAAE,IAAI,SAAS,CAAC;YACvB,GAAG,QAAQ,CAAC,SAAS;YACrB,UAAU;SACX,CAAC;QACF,MAAM,EAAE,IAAI,MAAM,CAAC;YACjB,GAAG,QAAQ,CAAC,MAAM;YAClB,UAAU;SACX,CAAC;KACH,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,mBAAmB,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,63 @@
+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 declare const MESSAGING: "messaging";
+export declare const PAYMENTS: "payments";
+export declare const PROFILE: "profile";
+export declare const SCHEDULER: "scheduler";
+export declare const UPLOAD: "upload";
+export type SERVICE_NAME = typeof MESSAGING | typeof PAYMENTS | typeof PROFILE | typeof SCHEDULER | typeof UPLOAD;
+export type TokenFunction = (serviceName: SERVICE_NAME) => Promise<string> | string;
+export type M2MParams = {
+    getOrganizationTokenParams?: GetOrganizationTokenParams;
+    getAccessTokenParams?: GetAccessTokenParams;
+};
+export type M2MTokenFnConfig = {
+    services: {
+        [key in SERVICE_NAME]?: M2MParams;
+    };
+};
+export type SDKClientParams = {
+    baseUrl?: string;
+};
+export type ApiClientParams = SDKClientParams & {
+    getTokenFn?: TokenFunction;
+};
+type ServiceClients = {
+    messaging: Messaging;
+    payments: Payments;
+    profile: Profile;
+    scheduler: Scheduler;
+    upload: Upload;
+};
+export type BuildingBlocksSDK = {
+    [key in keyof ServiceClients]: ServiceClients[key];
+};
+export type BuildingBlockSDKParams = {
+    services: {
+        [key in keyof ServiceClients]?: SDKClientParams;
+    };
+    getTokenFn?: TokenFunction;
+};
+export interface TokenResponseBody {
+    access_token: string;
+    expires_in: number;
+    token_type: string;
+    scope: string;
+}
+interface GetTokenBaseParams {
+    logtoOidcEndpoint: string;
+    applicationId: string;
+    applicationSecret: string;
+    scopes?: string[];
+}
+export interface GetAccessTokenParams extends GetTokenBaseParams {
+    resource: string;
+}
+export interface GetOrganizationTokenParams extends GetTokenBaseParams {
+    organizationId: string;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,SAAS,MAAM,sCAAsC,CAAC;AAClE,OAAO,KAAK,QAAQ,MAAM,qCAAqC,CAAC;AAChE,OAAO,KAAK,OAAO,MAAM,oCAAoC,CAAC;AAC9D,OAAO,KAAK,SAAS,MAAM,sCAAsC,CAAC;AAClE,OAAO,KAAK,MAAM,MAAM,mCAAmC,CAAC;AAE5D,eAAO,MAAM,SAAS,aAAuB,CAAC;AAC9C,eAAO,MAAM,QAAQ,YAAsB,CAAC;AAC5C,eAAO,MAAM,OAAO,WAAqB,CAAC;AAC1C,eAAO,MAAM,SAAS,aAAuB,CAAC;AAC9C,eAAO,MAAM,MAAM,UAAoB,CAAC;AAExC,MAAM,MAAM,YAAY,GACpB,OAAO,SAAS,GAChB,OAAO,QAAQ,GACf,OAAO,OAAO,GACd,OAAO,SAAS,GAChB,OAAO,MAAM,CAAC;AAElB,MAAM,MAAM,aAAa,GAAG,CAC1B,WAAW,EAAE,YAAY,KACtB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE9B,MAAM,MAAM,SAAS,GAAG;IACtB,0BAA0B,CAAC,EAAE,0BAA0B,CAAC;IACxD,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAC7C,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE;SACP,GAAG,IAAI,YAAY,CAAC,CAAC,EAAE,SAAS;KAClC,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C,UAAU,CAAC,EAAE,aAAa,CAAC;CAC5B,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,SAAS,EAAE,SAAS,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;KAC7B,GAAG,IAAI,MAAM,cAAc,GAAG,cAAc,CAAC,GAAG,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE;SACP,GAAG,IAAI,MAAM,cAAc,CAAC,CAAC,EAAE,eAAe;KAChD,CAAC;IACF,UAAU,CAAC,EAAE,aAAa,CAAC;CAC5B,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,UAAU,kBAAkB;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB;IAC9D,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,cAAc,EAAE,MAAM,CAAC;CACxB"}

package/dist/types/index.js

@@ -0,0 +1,6 @@
+export const MESSAGING = "messaging";
+export const PAYMENTS = "payments";
+export const PROFILE = "profile";
+export const SCHEDULER = "scheduler";
+export const UPLOAD = "upload";
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,SAAS,GAAG,WAAoB,CAAC;AAC9C,MAAM,CAAC,MAAM,QAAQ,GAAG,UAAmB,CAAC;AAC5C,MAAM,CAAC,MAAM,OAAO,GAAG,SAAkB,CAAC;AAC1C,MAAM,CAAC,MAAM,SAAS,GAAG,WAAoB,CAAC;AAC9C,MAAM,CAAC,MAAM,MAAM,GAAG,QAAiB,CAAC"}

package/dist/utils/get-absolute-path.d.ts

@@ -0,0 +1,3 @@
+declare function getAbsolutePath(...relativeInputPath: string[]): string;
+export default getAbsolutePath;
+//# sourceMappingURL=get-absolute-path.d.ts.map

package/dist/utils/get-absolute-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-absolute-path.d.ts","sourceRoot":"","sources":["../../src/utils/get-absolute-path.ts"],"names":[],"mappings":"AAKA,iBAAS,eAAe,CAAC,GAAG,iBAAiB,EAAE,MAAM,EAAE,GAAG,MAAM,CAE/D;AAED,eAAe,eAAe,CAAC"}

package/dist/utils/get-absolute-path.js

@@ -0,0 +1,8 @@
+import { dirname, resolve } from "path";
+import { fileURLToPath } from "url";
+const __dirname = dirname(fileURLToPath(import.meta.url));
+function getAbsolutePath(...relativeInputPath) {
+    return resolve(__dirname, "..", "..", ...relativeInputPath);
+}
+export default getAbsolutePath;
+//# sourceMappingURL=get-absolute-path.js.map

package/dist/utils/get-absolute-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-absolute-path.js","sourceRoot":"","sources":["../../src/utils/get-absolute-path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE1D,SAAS,eAAe,CAAC,GAAG,iBAA2B;IACrD,OAAO,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,iBAAiB,CAAC,CAAC;AAC9D,CAAC;AAED,eAAe,eAAe,CAAC"}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@ogcio/building-blocks-sdk",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "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"
+  },
+  "dependencies": {
+    "@sinclair/typebox": "^0.33.15",
+    "commander": "^12.1.0",
+    "http-errors": "^2.0.0",
+    "openapi-fetch": "^0.12.2",
+    "openapi-typescript": "^7.4.1",
+    "openapi-typescript-helpers": "^0.0.13",
+    "safe-stable-stringify": "^2.5.0",
+    "yaml": "^2.5.1"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.3",
+    "@commitlint/config-conventional": "^19.5.0",
+    "@types/http-errors": "^2.0.4",
+    "commitlint": "^19.5.0",
+    "husky": "^9.1.6",
+    "tsx": "^4.19.1",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "@logto/node": "^2.5.8"
+  },
+  "peerDependenciesMeta": {
+    "@logto/node": {
+      "optional": true
+    }
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": ""
+}

package/src/cli/cli-utils.ts

@@ -0,0 +1,25 @@
+import fs from "node:fs";
+
+export const CLIENTS_ROOT_FOLDER_PATH = "src/client/clients";
+export const OPEN_API_DEFINITION_FILE_NAME = "open-api-definition.json";
+export const OLD_OPEN_API_DEFINITION_FILE_NAME = "old-open-api-definition.json";
+export const SCHEMA_FILE_NAME = "schema.ts";
+export const OLD_SCHEMA_FILE_NAME = "old-schema.ts";
+
+export async function getOpenApiDefinitionFileContent(
+  filePath: string,
+): Promise<string> {
+  if (fs.existsSync(filePath)) {
+    return fs.readFileSync(filePath, "utf-8");
+  }
+
+  try {
+    const url = new URL(filePath);
+    const response = await fetch(url);
+    return response.text();
+  } catch {}
+
+  throw new Error(
+    `The configuration-file-path is not a valid file path nor url, or it is not reachable: ${filePath}`,
+  );
+}

package/src/cli/index.ts

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+import { program } from "commander";
+import outdatedClientsCommand from "./outdated-clients-command.js";
+import updateClientsCommand from "./update-clients-command.js";
+
+program
+  .name("building-blocks-cli")
+  .description("CLI with tools for managing the building blocks SDK")
+  .version("0.0.1")
+  .addCommand(updateClientsCommand)
+  .addCommand(outdatedClientsCommand);
+
+program.parseAsync(process.argv);

package/src/cli/outdated-clients-command.ts

@@ -0,0 +1,148 @@
+import fs from "node:fs";
+import { Command } from "commander";
+import { stringify as stableStringify } from "safe-stable-stringify";
+import { parse } from "yaml";
+import {
+  type ConfigurationBuildingBlock,
+  OpenAPIFileFormats,
+  readConfigurationFile,
+} from "../clients-configurations/read-configuration-file.js";
+import getAbsolutePath from "../utils/get-absolute-path.js";
+import {
+  CLIENTS_ROOT_FOLDER_PATH,
+  OPEN_API_DEFINITION_FILE_NAME,
+  getOpenApiDefinitionFileContent,
+} from "./cli-utils.js";
+
+/**
+ * This command, starting from a json configuration file,
+ * downloads the open-API definition file,
+ * parse it and compare it with the already existent one
+ */
+
+function stringify(input: unknown): string {
+  stableStringify.configure({ deterministic: true });
+
+  const stringified = stableStringify(input);
+  if (!stringified) {
+    throw new Error("Invalid item to stringify!");
+  }
+
+  return stringified;
+}
+
+async function getLatestDefinitionFileContent({
+  inputBuildingBlock,
+}: {
+  inputBuildingBlock: ConfigurationBuildingBlock;
+}): Promise<string> {
+  log(`${inputBuildingBlock.name} - Downloading Open API definition file`);
+  const downloadedFileContent = await getOpenApiDefinitionFileContent(
+    inputBuildingBlock.openApiDefinitionUrl,
+  );
+  log(`${inputBuildingBlock.name} - Open API definition file downloaded`);
+  const openApiParsed =
+    inputBuildingBlock.openApiDefinitionFormat === OpenAPIFileFormats.JSON
+      ? JSON.parse(downloadedFileContent)
+      : parse(downloadedFileContent);
+  log(`${inputBuildingBlock.name} - Open API definition file parsed`);
+  return stringify(openApiParsed);
+}
+
+async function isBuildingBlockOutdated({
+  inputBuildingBlock,
+}: {
+  inputBuildingBlock: ConfigurationBuildingBlock;
+}): Promise<{ name: string; isOutdated: boolean }> {
+  if (inputBuildingBlock.updateDefinitions === false) {
+    log(`${inputBuildingBlock.name} - Update definition is disabled, ignoring`);
+    return { name: inputBuildingBlock.name, isOutdated: false };
+  }
+  log(`${inputBuildingBlock.name} - Processing`);
+  try {
+    const latestDefinition = await getLatestDefinitionFileContent({
+      inputBuildingBlock,
+    });
+
+    const serviceFolderPath = getAbsolutePath(
+      CLIENTS_ROOT_FOLDER_PATH,
+      inputBuildingBlock.name,
+    );
+    const definitionFilePath = getAbsolutePath(
+      serviceFolderPath,
+      OPEN_API_DEFINITION_FILE_NAME,
+    );
+
+    if (
+      !fs.existsSync(serviceFolderPath) ||
+      !fs.existsSync(definitionFilePath)
+    ) {
+      return { name: inputBuildingBlock.name, isOutdated: true };
+    }
+
+    const storedFile = fs.readFileSync(definitionFilePath, {
+      encoding: "utf-8",
+    });
+
+    const stringifiedStored = stringify(JSON.parse(storedFile));
+
+    const isOutdated = stringifiedStored !== latestDefinition;
+    log(
+      `${inputBuildingBlock.name} - Processed. Building Block is ${isOutdated ? "OUTDATED!" : "not outdated"}`,
+    );
+
+    return { name: inputBuildingBlock.name, isOutdated };
+  } catch (e) {
+    log(`${inputBuildingBlock.name} - Error While Processing`);
+    throw e;
+  }
+}
+
+function log(message: string, ...params: unknown[]): void {
+  if (params.length === 0) {
+    console.log(`Outdated Clients: ${message}`);
+    return;
+  }
+  console.log(`Outdated Clients: ${message}`, params);
+}
+async function checkClients({
+  configurationFilePath,
+}: { configurationFilePath: string }): Promise<void> {
+  const configurationFile = await readConfigurationFile(configurationFilePath);
+  log("Configuration file read");
+
+  const promises: Promise<{ name: string; isOutdated: boolean }>[] = [];
+  for (const inputBuilding of Object.values(configurationFile.buildingBlocks)) {
+    promises.push(
+      isBuildingBlockOutdated({ inputBuildingBlock: inputBuilding }),
+    );
+  }
+
+  const bbStatuses = await Promise.all(promises);
+  const outdated = bbStatuses
+    .filter((bb) => bb.isOutdated === true)
+    .map((bb) => bb.name);
+  if (outdated.length) {
+    throw new Error(
+      `The following building blocks are outdated: ${outdated.join(", ")}`,
+    );
+  }
+
+  log("All the building blocks are updated!");
+}
+const outdatedClientsCommand = new Command("clients:outdated");
+outdatedClientsCommand
+  .description(
+    "Parse a configuration file to check if the clients need to be updated",
+  )
+  .requiredOption(
+    "-c, --configuration-file-path <configuration-path>",
+    "Path of the configuration file to parse",
+    (value: string) => getAbsolutePath(value),
+  )
+  .action(async (options: { configurationFilePath: string }) => {
+    log("Started!");
+    await checkClients(options);
+  });
+
+export default outdatedClientsCommand;