core-services-sdk 1.3.31 → 1.3.33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-services-sdk",
-  "version": "1.3.31",
+  "version": "1.3.33",
   "main": "src/index.js",
   "type": "module",
   "types": "types/index.d.ts",

package/src/ids/generators.js

@@ -88,3 +88,130 @@ export const generateOnboardingId = () =>
  * @returns {string} A session ID.
  */
 export const generateSessionId = () => generatePrefixedId(ID_PREFIXES.SESSION)
+
+/**
+ * Generates a file ID with a `fil_` prefix.
+ *
+ * @returns {string} A file ID.
+ */
+export const generateFileId = () => generatePrefixedId(ID_PREFIXES.FILE)
+
+/**
+ * Generates an event ID with an `evt_` prefix.
+ *
+ * @returns {string} An event ID.
+ */
+export const generateEventId = () => generatePrefixedId(ID_PREFIXES.EVENT)
+
+/**
+ * Generates a job ID with a `job_` prefix.
+ *
+ * @returns {string} A job ID.
+ */
+export const generateJobId = () => generatePrefixedId(ID_PREFIXES.JOB)
+
+/**
+ * Generates a task ID with a `task_` prefix.
+ *
+ * @returns {string} A task ID.
+ */
+export const generateTaskId = () => generatePrefixedId(ID_PREFIXES.TASK)
+
+/**
+ * Generates a queue ID with a `que_` prefix.
+ *
+ * @returns {string} A queue ID.
+ */
+export const generateQueueId = () => generatePrefixedId(ID_PREFIXES.QUEUE)
+
+/**
+ * Generates a message ID with a `msg_` prefix.
+ *
+ * @returns {string} A message ID.
+ */
+export const generateMessageId = () => generatePrefixedId(ID_PREFIXES.MESSAGE)
+
+/**
+ * Generates a notification ID with a `ntf_` prefix.
+ *
+ * @returns {string} A notification ID.
+ */
+export const generateNotificationId = () =>
+  generatePrefixedId(ID_PREFIXES.NOTIFICATION)
+
+/**
+ * Generates a log ID with a `log_` prefix.
+ *
+ * @returns {string} A log ID.
+ */
+export const generateLogId = () => generatePrefixedId(ID_PREFIXES.LOG)
+
+/**
+ * Generates an audit ID with an `adt_` prefix.
+ *
+ * @returns {string} An audit ID.
+ */
+export const generateAuditId = () => generatePrefixedId(ID_PREFIXES.AUDIT)
+
+/**
+ * Generates a config ID with a `cfg_` prefix.
+ *
+ * @returns {string} A config ID.
+ */
+export const generateConfigId = () => generatePrefixedId(ID_PREFIXES.CONFIG)
+
+/**
+ * Generates a key ID with a `key_` prefix.
+ *
+ * @returns {string} A key ID.
+ */
+export const generateKeyId = () => generatePrefixedId(ID_PREFIXES.KEY)
+
+/**
+ * Generates a metric ID with a `met_` prefix.
+ *
+ * @returns {string} A metric ID.
+ */
+export const generateMetricId = () => generatePrefixedId(ID_PREFIXES.METRIC)
+
+/**
+ * Generates a tag ID with a `tag_` prefix.
+ *
+ * @returns {string} A tag ID.
+ */
+export const generateTagId = () => generatePrefixedId(ID_PREFIXES.TAG)
+
+/**
+ * Generates a policy ID with a `plc_` prefix.
+ *
+ * @returns {string} A policy ID.
+ */
+export const generatePolicyId = () => generatePrefixedId(ID_PREFIXES.POLICY)
+
+/**
+ * Generates a profile ID with a `prf_` prefix.
+ *
+ * @returns {string} A profile ID.
+ */
+export const generateProfileId = () => generatePrefixedId(ID_PREFIXES.PROFILE)
+
+/**
+ * Generates a device ID with a `dev_` prefix.
+ *
+ * @returns {string} A device ID.
+ */
+export const generateDeviceId = () => generatePrefixedId(ID_PREFIXES.DEVICE)
+
+/**
+ * Generates an alert ID with an `alr_` prefix.
+ *
+ * @returns {string} An alert ID.
+ */
+export const generateAlertId = () => generatePrefixedId(ID_PREFIXES.ALERT)
+
+/**
+ * Generates a resource ID with a `res_` prefix.
+ *
+ * @returns {string} A resource ID.
+ */
+export const generateResourceId = () => generatePrefixedId(ID_PREFIXES.RESOURCE)

package/src/ids/prefixes.js

@@ -31,4 +31,58 @@ export const ID_PREFIXES = Object.freeze({
 
   /** Session mapping ID prefix */
   SESSION: 'sess',
+
+  /** File mapping ID prefix */
+  FILE: 'fil',
+
+  /** Event entity ID prefix */
+  EVENT: 'evt',
+
+  /** Job entity ID prefix */
+  JOB: 'job',
+
+  /** Task entity ID prefix */
+  TASK: 'task',
+
+  /** Queue entity ID prefix */
+  QUEUE: 'que',
+
+  /** Message entity ID prefix */
+  MESSAGE: 'msg',
+
+  /** Notification entity ID prefix */
+  NOTIFICATION: 'ntf',
+
+  /** Log entity ID prefix */
+  LOG: 'log',
+
+  /** Audit entity ID prefix */
+  AUDIT: 'adt',
+
+  /** Config entity ID prefix */
+  CONFIG: 'cfg',
+
+  /** Key entity ID prefix */
+  KEY: 'key',
+
+  /** Metric entity ID prefix */
+  METRIC: 'met',
+
+  /** Tag entity ID prefix */
+  TAG: 'tag',
+
+  /** Policy entity ID prefix */
+  POLICY: 'plc',
+
+  /** Profile entity ID prefix */
+  PROFILE: 'prf',
+
+  /** Device entity ID prefix */
+  DEVICE: 'dev',
+
+  /** Alert entity ID prefix */
+  ALERT: 'alr',
+
+  /** Resource entity ID prefix */
+  RESOURCE: 'res',
 })

package/tests/ids/generators.unit.test.js

@@ -11,6 +11,24 @@ import {
   generateVerificationId,
   generateRolePermissionsId,
   generateSessionId,
+  generateFileId,
+  generateEventId,
+  generateJobId,
+  generateTaskId,
+  generateQueueId,
+  generateMessageId,
+  generateNotificationId,
+  generateLogId,
+  generateAuditId,
+  generateConfigId,
+  generateKeyId,
+  generateMetricId,
+  generateTagId,
+  generatePolicyId,
+  generateProfileId,
+  generateDeviceId,
+  generateAlertId,
+  generateResourceId,
 } from '../../src/ids/generators.js'
 import { ID_PREFIXES } from '../../src/ids/prefixes.js'
 
@@ -79,4 +97,76 @@ describe('generate*Id functions', () => {
   it('generateSessionId returns ID with sess_ prefix', () => {
     testPrefixFunction(generateSessionId, ID_PREFIXES.SESSION)
   })
+
+  it('generateFileId returns ID with fil_ prefix', () => {
+    testPrefixFunction(generateFileId, ID_PREFIXES.FILE)
+  })
+
+  it('generateEventId returns ID with evt_ prefix', () => {
+    testPrefixFunction(generateEventId, ID_PREFIXES.EVENT)
+  })
+
+  it('generateJobId returns ID with job_ prefix', () => {
+    testPrefixFunction(generateJobId, ID_PREFIXES.JOB)
+  })
+
+  it('generateTaskId returns ID with task_ prefix', () => {
+    testPrefixFunction(generateTaskId, ID_PREFIXES.TASK)
+  })
+
+  it('generateQueueId returns ID with que_ prefix', () => {
+    testPrefixFunction(generateQueueId, ID_PREFIXES.QUEUE)
+  })
+
+  it('generateMessageId returns ID with msg_ prefix', () => {
+    testPrefixFunction(generateMessageId, ID_PREFIXES.MESSAGE)
+  })
+
+  it('generateNotificationId returns ID with ntf_ prefix', () => {
+    testPrefixFunction(generateNotificationId, ID_PREFIXES.NOTIFICATION)
+  })
+
+  it('generateLogId returns ID with log_ prefix', () => {
+    testPrefixFunction(generateLogId, ID_PREFIXES.LOG)
+  })
+
+  it('generateAuditId returns ID with adt_ prefix', () => {
+    testPrefixFunction(generateAuditId, ID_PREFIXES.AUDIT)
+  })
+
+  it('generateConfigId returns ID with cfg_ prefix', () => {
+    testPrefixFunction(generateConfigId, ID_PREFIXES.CONFIG)
+  })
+
+  it('generateKeyId returns ID with key_ prefix', () => {
+    testPrefixFunction(generateKeyId, ID_PREFIXES.KEY)
+  })
+
+  it('generateMetricId returns ID with met_ prefix', () => {
+    testPrefixFunction(generateMetricId, ID_PREFIXES.METRIC)
+  })
+
+  it('generateTagId returns ID with tag_ prefix', () => {
+    testPrefixFunction(generateTagId, ID_PREFIXES.TAG)
+  })
+
+  it('generatePolicyId returns ID with plc_ prefix', () => {
+    testPrefixFunction(generatePolicyId, ID_PREFIXES.POLICY)
+  })
+
+  it('generateProfileId returns ID with prf_ prefix', () => {
+    testPrefixFunction(generateProfileId, ID_PREFIXES.PROFILE)
+  })
+
+  it('generateDeviceId returns ID with dev_ prefix', () => {
+    testPrefixFunction(generateDeviceId, ID_PREFIXES.DEVICE)
+  })
+
+  it('generateAlertId returns ID with alr_ prefix', () => {
+    testPrefixFunction(generateAlertId, ID_PREFIXES.ALERT)
+  })
+
+  it('generateResourceId returns ID with res_ prefix', () => {
+    testPrefixFunction(generateResourceId, ID_PREFIXES.RESOURCE)
+  })
 })

package/tests/ids/prefixes.unit.test.js

@@ -14,6 +14,24 @@ describe('ID_PREFIXES', () => {
       ROLE_PERMISSIONS: 'role',
       ONBOARDING: 'onb',
       SESSION: 'sess',
+      FILE: 'fil',
+      EVENT: 'evt',
+      JOB: 'job',
+      TASK: 'task',
+      QUEUE: 'que',
+      MESSAGE: 'msg',
+      NOTIFICATION: 'ntf',
+      LOG: 'log',
+      AUDIT: 'adt',
+      CONFIG: 'cfg',
+      KEY: 'key',
+      METRIC: 'met',
+      TAG: 'tag',
+      POLICY: 'plc',
+      PROFILE: 'prf',
+      DEVICE: 'dev',
+      ALERT: 'alr',
+      RESOURCE: 'res',
     })
   })
 

package/types/ids/generators.d.ts

@@ -8,3 +8,21 @@ export function generateVerificationId(): string;
 export function generateRolePermissionsId(): string;
 export function generateOnboardingId(): string;
 export function generateSessionId(): string;
+export function generateFileId(): string;
+export function generateEventId(): string;
+export function generateJobId(): string;
+export function generateTaskId(): string;
+export function generateQueueId(): string;
+export function generateMessageId(): string;
+export function generateNotificationId(): string;
+export function generateLogId(): string;
+export function generateAuditId(): string;
+export function generateConfigId(): string;
+export function generateKeyId(): string;
+export function generateMetricId(): string;
+export function generateTagId(): string;
+export function generatePolicyId(): string;
+export function generateProfileId(): string;
+export function generateDeviceId(): string;
+export function generateAlertId(): string;
+export function generateResourceId(): string;

package/types/ids/prefixes.d.ts

@@ -31,4 +31,40 @@ export const ID_PREFIXES: Readonly<{
     ONBOARDING: "onb";
     /** Session mapping ID prefix */
     SESSION: "sess";
+    /** File mapping ID prefix */
+    FILE: "fil";
+    /** Event entity ID prefix */
+    EVENT: "evt";
+    /** Job entity ID prefix */
+    JOB: "job";
+    /** Task entity ID prefix */
+    TASK: "task";
+    /** Queue entity ID prefix */
+    QUEUE: "que";
+    /** Message entity ID prefix */
+    MESSAGE: "msg";
+    /** Notification entity ID prefix */
+    NOTIFICATION: "ntf";
+    /** Log entity ID prefix */
+    LOG: "log";
+    /** Audit entity ID prefix */
+    AUDIT: "adt";
+    /** Config entity ID prefix */
+    CONFIG: "cfg";
+    /** Key entity ID prefix */
+    KEY: "key";
+    /** Metric entity ID prefix */
+    METRIC: "met";
+    /** Tag entity ID prefix */
+    TAG: "tag";
+    /** Policy entity ID prefix */
+    POLICY: "plc";
+    /** Profile entity ID prefix */
+    PROFILE: "prf";
+    /** Device entity ID prefix */
+    DEVICE: "dev";
+    /** Alert entity ID prefix */
+    ALERT: "alr";
+    /** Resource entity ID prefix */
+    RESOURCE: "res";
 }>;

package/types/mongodb/connect.d.ts

@@ -1,4 +1,7 @@
-export function mongoConnect({ uri, serverApi }: {
+export function mongoConnect({ uri, serverApi, timeout, retries, }: {
     uri: string;
     serverApi?: object;
-}): Promise<import("mongodb").MongoClient>;
+    timeout?: number;
+    retries?: number;
+}): Promise<MongoClient>;
+import { MongoClient } from 'mongodb';

package/types/mongodb/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./connect.js";
+export * from "./paginate.js";
 export * from "./dsl-to-mongo.js";
 export * from "./initialize-mongodb.js";
 export * from "./validate-mongo-uri.js";

package/types/mongodb/paginate.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Pagination with SQL-like ascending/descending
+ *
+ * @param {import('mongodb').Collection} collection
+ * @param {Object} options
+ * @param {Object} [options.filter={}]
+ * @param {string} [options.cursorField='_id']
+ * @param {string|Date|ObjectId} [options.cursor]
+ * @param {'asc'|'desc'} [options.order='asc']
+ * @param {number} [options.limit=10]
+ */
+export function paginate(collection: import("mongodb").Collection, { limit, projection, filter, cursor, order, cursorField, }?: {
+    filter?: any;
+    cursorField?: string;
+    cursor?: string | Date | ObjectId;
+    order?: "asc" | "desc";
+    limit?: number;
+}): Promise<{
+    order: "desc" | "asc";
+    list: import("mongodb").WithId<import("bson").Document>[];
+    previous: any;
+    next: any;
+}>;
+import { ObjectId } from 'mongodb';

package/types/util/context.d.ts

@@ -0,0 +1,55 @@
+export namespace Context {
+    /**
+     * Run a callback within a given context store.
+     * Everything `await`ed or invoked inside this callback will have access
+     * to the provided store via {@link Context.get}, {@link Context.set}, or {@link Context.all}.
+     *
+     * @template T
+     * @param {Record<string, any>} store
+     * @param {() => T} callback - Function to execute inside the context.
+     * @returns {T} The return value of the callback (sync or async).
+     *
+     * @example
+     * Context.run(
+     *   { correlationId: 'abc123' },
+     *   async () => {
+     *     console.log(Context.get('correlationId')) // "abc123"
+     *   }
+     * )
+     */
+    function run<T>(store: Record<string, any>, callback: () => T): T;
+    /**
+     * Retrieve a single value from the current async context store.
+     *
+     * @template T
+     * @param {string} key - The key of the value to retrieve.
+     * @returns {T|undefined} The stored value, or `undefined` if no store exists or key not found.
+     *
+     * @example
+     * const userId = Context.get('userId')
+     */
+    function get<T>(key: string): T | undefined;
+    /**
+     * Set a single key-value pair in the current async context store.
+     * If there is no active store (i.e. outside of a {@link Context.run}),
+     * this function does nothing.
+     *
+     * @param {string} key - The key under which to store the value.
+     * @param {any} value - The value to store.
+     *
+     * @example
+     * Context.set('tenantId', 'tnt_1234')
+     */
+    function set(key: string, value: any): void;
+    /**
+     * Get the entire store object for the current async context.
+     *
+     * @returns {Record<string, any>} The current store object,
+     * or an empty object if no store exists.
+     *
+     * @example
+     * const all = Context.all()
+     * console.log(all) // { correlationId: 'abc123', userId: 'usr_789' }
+     */
+    function all(): Record<string, any>;
+}

package/types/util/index.d.ts

@@ -2,6 +2,7 @@ export namespace util {
     export { mask };
     export { maskSingle };
 }
+export { Context } from "./context.js";
 import { mask } from './mask-sensitive.js';
 import { maskSingle } from './mask-sensitive.js';
 export { mask, maskSingle };