@binalyze/air-sdk 5.2.0 → 5.4.1

package/dist/types/organization.d.ts

@@ -1,13 +1,65 @@
-export interface OrganizationAPI {
-    addTags: (organizationId: number, tags: string[]) => Promise<any>;
-    assignUsers: (organizationId: number, userIds: string[]) => Promise<any>;
-    checkNameExists: (name: string) => Promise<any>;
-    create: (input: any) => Promise<any>;
-    get: (organizationId: number) => Promise<any>;
-    getMany: (pageNumber?: number, pageSize?: number, filter?: unknown) => Promise<any>;
-    getUsers: (organizationId: number, pageNumber?: number, pageSize?: number, filter?: unknown) => Promise<any>;
-    removeTags: (organizationId: number, tags: string[]) => Promise<any>;
-    removeUsers: (organizationId: number, userIds: string[]) => Promise<any>;
-    update: (organizationId: number, input: any) => Promise<any>;
-    updateShareableDeploymentStatus: (organizationId: number, status: boolean) => Promise<any>;
+import type { OrganizationsGetManyData, OrganizationGetResponses, OrganizationGetData, OrganizationCreateData, OrganizationCreateResponses, OrganizationUpdateData, OrganizationRemoveUsersData, OrganizationAssignUsersData, OrganizationRemoveTagsData, OrganizationAddTagsData, OrganizationGetUsersResponses, OrganizationUpdateShareableDeploymentStatusData, OrganizationUpdateDeploymentTokenData, FilterOrganizationUsersDto } from '../generated/bindings';
+import type { IPaginationMetadata } from './common';
+export type Organization = OrganizationGetResponses[200];
+export interface IOrganizationsPage extends Array<OrganizationListItem> {
+    _pagination?: IPaginationMetadata;
+}
+export type OrganizationUser = OrganizationGetUsersResponses[200] extends infer T ? T extends {
+    entities: Array<infer U>;
+} ? U : unknown : unknown;
+export interface IOrganizationUsersPage extends Array<OrganizationUser> {
+    _pagination?: IPaginationMetadata;
+}
+export type OrganizationListItem = OrganizationCreateResponses[201];
+export interface IAssignUsersResult {
+    organization: Organization;
+    requestedUserIds: string[];
+    assignedUserIds: string[];
+    notAssignedUserIds: string[];
+}
+export interface IOrganizationAPI {
+    addTags: (options: {
+        id?: number;
+        tags: OrganizationAddTagsData['body']['tags'];
+    }) => Promise<OrganizationListItem>;
+    assignUsers: (options: {
+        id?: number;
+        userIds: OrganizationAssignUsersData['body']['userIds'];
+    }) => Promise<IAssignUsersResult>;
+    checkNameExists: (options: {
+        name: string;
+    }) => Promise<boolean>;
+    create: (options: {
+        input: OrganizationCreateData['body'];
+    }) => Promise<OrganizationListItem>;
+    get: (options?: OrganizationGetData['path']) => Promise<Organization>;
+    getMany: (options?: OrganizationsGetManyData['query']) => Promise<IOrganizationsPage>;
+    getUsers: (options?: {
+        id?: number;
+        pageNumber?: number;
+        pageSize?: number;
+        sortType?: 'ASC' | 'DESC';
+        sortBy?: string;
+        filter?: FilterOrganizationUsersDto;
+    }) => Promise<IOrganizationUsersPage>;
+    removeTags: (options: {
+        id?: number;
+        tags: OrganizationRemoveTagsData['body']['tags'];
+    }) => Promise<OrganizationListItem>;
+    removeUsers: (options: {
+        id?: number;
+        userIds: OrganizationRemoveUsersData['body']['userIds'];
+    }) => Promise<Organization>;
+    update: (options: {
+        id?: number;
+        input: OrganizationUpdateData['body'];
+    }) => Promise<OrganizationListItem>;
+    updateShareableDeploymentStatus: (options: {
+        id?: number;
+        status: OrganizationUpdateShareableDeploymentStatusData['body']['status'];
+    }) => Promise<boolean>;
+    updateDeploymentToken: (options: {
+        id?: number;
+        token: OrganizationUpdateDeploymentTokenData['body']['deploymentToken'];
+    }) => Promise<string>;
 }

package/dist/types/organization.js

@@ -1,3 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+;
+;
+;
 //# sourceMappingURL=organization.js.map

package/dist/types/organization.js.map

@@ -1 +1 @@
-{"version":3,"file":"organization.js","sourceRoot":"","sources":["../../src/types/organization.ts"],"names":[],"mappings":""}
+{"version":3,"file":"organization.js","sourceRoot":"","sources":["../../src/types/organization.ts"],"names":[],"mappings":";;AAsBC,CAAC;AAUD,CAAC;AAQD,CAAC"}

package/dist/types/repositories.d.ts

@@ -1,4 +1,20 @@
-export interface RepositoriesAPI {
-    get: (id: string) => Promise<any>;
-    getMany: (organizationIds: number[], pageNumber?: number, pageSize?: number) => Promise<any>;
+import type { EvidenceRepositoryFilterDto, EvidenceRepositoriesGetResponses } from '../generated/bindings';
+import type { IPaginationMetadata } from './common';
+export type EvidenceRepository = EvidenceRepositoriesGetResponses[200];
+export interface IEvidenceRepositoriesPage extends Array<EvidenceRepository> {
+    _pagination?: IPaginationMetadata;
+}
+export interface IGetEvidenceRepositoryOptions {
+    id: string;
+}
+export interface IGetEvidenceRepositoriesOptions {
+    pageNumber?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortType?: 'ASC' | 'DESC';
+    filter?: Partial<EvidenceRepositoryFilterDto>;
+}
+export interface IRepositoriesAPI {
+    get: (options: IGetEvidenceRepositoryOptions) => Promise<EvidenceRepository>;
+    getMany: (options?: IGetEvidenceRepositoriesOptions) => Promise<IEvidenceRepositoriesPage>;
 }

package/dist/types/repositories.js

@@ -1,3 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+;
 //# sourceMappingURL=repositories.js.map

package/dist/types/repositories.js.map

@@ -1 +1 @@
-{"version":3,"file":"repositories.js","sourceRoot":"","sources":["../../src/types/repositories.ts"],"names":[],"mappings":""}
+{"version":3,"file":"repositories.js","sourceRoot":"","sources":["../../src/types/repositories.ts"],"names":[],"mappings":";;AAUC,CAAC"}

package/dist/types/tasks.d.ts

@@ -1,7 +1,125 @@
-export interface TasksAPI {
-    get: (id: string) => Promise<any>;
-    getMany: (organizationIds: number[], pageNumber?: number, pageSize?: number) => Promise<any>;
-    getData: (id: string) => Promise<any>;
-    getAssignment: (assignmentId: string) => Promise<any>;
-    getAssignments: (id: string, pageNumber?: number, pageSize?: number) => Promise<any>;
+import type { TaskAssignmentGetResponses, TasksGetByIdResponses } from '../generated/bindings';
+import type { IPaginationMetadata } from './common';
+export interface ITaskEntity {
+    _id: string;
+    source?: string;
+    endpointFilter?: {
+        organizationIds?: number[];
+        includedEndpointIds?: string[];
+        excludedEndpointIds?: string[];
+        [key: string]: unknown;
+    };
+    totalAssignedEndpoints?: number;
+    totalCompletedEndpoints?: number;
+    totalFailedEndpoints?: number;
+    totalCancelledEndpoints?: number;
+    name?: string;
+    type?: string;
+    organizationId?: number;
+    status?: string;
+    createdBy?: string;
+    baseTaskId?: string | null;
+    schedulerConfig?: {
+        when?: string;
+        [key: string]: unknown;
+    };
+    metadata?: Record<string, unknown>;
+    totalMatched?: number | null;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export type Task = TasksGetByIdResponses[200] & ITaskEntity;
+export interface ISdkTask {
+    _id: string;
+    status?: string;
+    type?: string;
+    name?: string;
+    source?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+export interface ITasksPage extends Array<ITaskEntity> {
+    _pagination?: IPaginationMetadata;
+}
+export interface ITaskAssignmentEntity {
+    _id: string;
+    taskId?: string;
+    name?: string;
+    type?: string;
+    endpointId?: string;
+    endpointName?: string;
+    organizationId?: number;
+    status?: string;
+    subStatus?: string | null;
+    recurrence?: unknown | null;
+    progress?: number;
+    durations?: Record<string, number>;
+    duration?: number;
+    caseIds?: string[];
+    metadata?: ITaskAssignmentMetadata;
+    createdAt?: string;
+    createdBy?: string;
+    updatedAt?: string;
+    displayType?: string;
+    response?: ITaskAssignmentResponse;
+    reportUrl?: string;
+    isReportReady?: boolean;
+}
+export type TaskAssignment = TaskAssignmentGetResponses[200] & ITaskAssignmentEntity;
+export interface ITaskAssignmentsPage extends Array<ITaskAssignmentEntity> {
+    _pagination?: IPaginationMetadata;
+}
+export interface ITaskAssignmentMetadata {
+    purged?: boolean;
+    hasCaseDb?: boolean;
+    hasCasePpc?: boolean;
+    hasDroneData?: boolean;
+    taskCreatedByFullName?: string;
+    [key: string]: unknown;
+}
+export interface ITaskAssignmentResponse {
+    errorMessage?: string | null;
+    caseDirectory?: string | null;
+    matchCount?: number | null;
+    result?: unknown;
+    [key: string]: unknown;
+}
+export interface IGetTaskOptions {
+    id: string;
+}
+export interface ITaskFilters {
+    organizationIds?: number[];
+    searchTerm?: string;
+    name?: string;
+    type?: string[];
+    source?: string[];
+    status?: string[];
+    executionType?: string[];
+}
+export interface IGetTasksOptions {
+    pageNumber?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortType?: 'ASC' | 'DESC';
+    filter?: ITaskFilters;
+}
+export interface IGetTaskAssignmentsOptions {
+    id: string;
+    pageNumber?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortType?: 'ASC' | 'DESC';
+    filter?: ITaskAssignmentFilters;
+    includeFilter?: boolean;
+}
+export interface ITaskAssignmentFilters {
+    status?: string[];
+    searchTerm?: string;
+    hasDroneData?: boolean;
+    endpointIds?: string[];
+}
+export interface ITasksAPI {
+    get: (options: IGetTaskOptions) => Promise<Task>;
+    getMany: (options?: IGetTasksOptions) => Promise<ITasksPage>;
+    getAssignments: (options: IGetTaskAssignmentsOptions) => Promise<ITaskAssignmentsPage>;
 }

package/dist/types/triage.d.ts

@@ -1,11 +1,47 @@
-export interface TriageAPI {
-    getMany: (organizationId: number, pageNumber?: number, pageSize?: number) => Promise<any>;
-    get: (id: string) => Promise<any>;
-    create: (input: {
-        description: string;
-        rule: string;
-        engine: string;
-        searchIn: string;
-        organizationIds: number[];
-    } | any) => Promise<any>;
+import type { AssignTriageTaskResponses, CreateTriageRuleData, GetManyTriageRulesData, GetManyTriageRulesResponses, GetTriageRuleResponses, ValidateTriageRuleRequestDto, AssignTriageTaskRequestDto, UpdateTriageRuleData } from '../generated/bindings';
+export type CreateCompatBody = CreateTriageRuleData['body'] & {
+    name?: string;
+};
+export type UpdateCompatBody = UpdateTriageRuleData['body'] & {
+    name?: string;
+    engine?: 'osquery' | 'yara' | 'sigma';
+};
+export interface IOperationResponse {
+    success: boolean;
+}
+export interface IRemoveResult {
+    id: string;
+    deleted: boolean;
+    status: number;
+    existed: boolean | null;
+}
+export type ValidationResponse = {
+    success: true;
+} | {
+    success: false;
+    status: number;
+    message: string;
+};
+export interface ITriageAPI {
+    getMany: (options?: GetManyTriageRulesData['query']) => Promise<GetManyTriageRulesResponses[200]>;
+    get: (options: {
+        id: string;
+    }) => Promise<GetTriageRuleResponses[200]>;
+    create: (options: {
+        body: CreateTriageRuleData['body'] | CreateCompatBody;
+    }) => Promise<IOperationResponse>;
+    update: (options: {
+        id: string;
+        body: UpdateTriageRuleData['body'] | UpdateCompatBody;
+    }) => Promise<IOperationResponse>;
+    remove: (options: {
+        id: string;
+        ensureExists?: boolean;
+    }) => Promise<IRemoveResult>;
+    validate: (options: {
+        body: ValidateTriageRuleRequestDto;
+    }) => Promise<ValidationResponse>;
+    assignTask: (options: {
+        body: AssignTriageTaskRequestDto;
+    }) => Promise<AssignTriageTaskResponses[200]>;
 }

package/dist/types/users.d.ts

@@ -1,4 +1,20 @@
-export interface UsersAPI {
-    get: (id: string) => Promise<any>;
-    getMany: (organizationId: number) => Promise<any>;
+import type { FilterUsersRequestDto, UserDto, UserManagementUsersGetResponses } from '../generated/bindings';
+import type { IPaginationMetadata } from './common';
+export type User = UserManagementUsersGetResponses[200];
+export interface IUsersPage extends Array<UserDto> {
+    _pagination?: IPaginationMetadata;
+}
+export interface IGetUserOptions {
+    id: string;
+}
+export interface IGetUsersOptions {
+    pageNumber?: number;
+    pageSize?: number;
+    sortBy?: string;
+    sortType?: 'ASC' | 'DESC';
+    filter?: Partial<FilterUsersRequestDto>;
+}
+export interface IUsersAPI {
+    get: (options: IGetUserOptions) => Promise<User>;
+    getMany: (options?: IGetUsersOptions) => Promise<IUsersPage>;
 }

package/dist/types/users.js

@@ -1,3 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+;
 //# sourceMappingURL=users.js.map

package/dist/types/users.js.map

@@ -1 +1 @@
-{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/types/users.ts"],"names":[],"mappings":""}
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/types/users.ts"],"names":[],"mappings":";;AAOC,CAAC"}

package/dist/utils/builders.d.ts

@@ -0,0 +1,26 @@
+import type { CasesGetActivitiesData, CasesGetEndpointsData, CasesGetManyData, CasesGetTasksData, CasesGetUsersData, FilterCaseActivitiesDto, FilterCaseTasksDto, FilterCaseUsersDto, FilterEndpointDto, AssetsGetManyData, AssetsGetTasksData } from '../generated/bindings';
+import type { IGetAssetsOptions, IGetAssetTasksOptions } from '../types';
+import type { IGetCasesOptions } from '../types';
+export declare function buildAssetsGetManyQuery(options?: IGetAssetsOptions): AssetsGetManyData['query'];
+export declare function buildAssetsGetTasksQuery(options: IGetAssetTasksOptions): AssetsGetTasksData['query'];
+export declare function buildCasesGetManyQuery(options?: IGetCasesOptions): CasesGetManyData['query'];
+export declare function buildCasesGetActivitiesQuery(options: {
+    pageNumber?: number;
+    pageSize?: number;
+    filter?: FilterCaseActivitiesDto;
+}): CasesGetActivitiesData['query'];
+export declare function buildCasesGetEndpointsQuery(options: {
+    pageNumber?: number;
+    pageSize?: number;
+    filter?: Partial<FilterEndpointDto>;
+}): CasesGetEndpointsData['query'];
+export declare function buildCasesGetTasksQuery(options: {
+    pageNumber?: number;
+    pageSize?: number;
+    filter?: FilterCaseTasksDto;
+}): CasesGetTasksData['query'];
+export declare function buildCasesGetUsersQuery(options: {
+    pageNumber?: number;
+    pageSize?: number;
+    filter?: FilterCaseUsersDto;
+}): CasesGetUsersData['query'];

package/dist/utils/builders.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAssetsGetManyQuery = buildAssetsGetManyQuery;
+exports.buildAssetsGetTasksQuery = buildAssetsGetTasksQuery;
+exports.buildCasesGetManyQuery = buildCasesGetManyQuery;
+exports.buildCasesGetActivitiesQuery = buildCasesGetActivitiesQuery;
+exports.buildCasesGetEndpointsQuery = buildCasesGetEndpointsQuery;
+exports.buildCasesGetTasksQuery = buildCasesGetTasksQuery;
+exports.buildCasesGetUsersQuery = buildCasesGetUsersQuery;
+const utils_1 = require("./utils");
+// Assets builders
+function buildAssetsGetManyQuery(options) {
+    const pageNumber = options?.pageNumber ?? 1;
+    const pageSize = options?.pageSize ?? 10;
+    const sortBy = options?.sortBy;
+    const sortType = options?.sortType;
+    const filter = (0, utils_1.ensureOrganizationIds)((options?.filter ?? {}));
+    return {
+        pageNumber,
+        pageSize,
+        ...(sortBy ? { sortBy } : {}),
+        ...(sortType ? { sortType } : {}),
+        filter: filter,
+    };
+}
+function buildAssetsGetTasksQuery(options) {
+    const pageNumber = options.pageNumber ?? 1;
+    const pageSize = options.pageSize ?? 10;
+    const sortBy = options.sortBy;
+    const sortType = options.sortType;
+    const filter = (options.filter ?? {});
+    return {
+        pageNumber,
+        pageSize,
+        ...(sortBy ? { sortBy } : {}),
+        ...(sortType ? { sortType } : {}),
+        filter,
+    };
+}
+// Cases builders
+function buildCasesGetManyQuery(options) {
+    const pageNumber = options?.pageNumber ?? 1;
+    const pageSize = options?.pageSize ?? 10;
+    const sortBy = options?.sortBy;
+    const sortType = options?.sortType;
+    const filter = (0, utils_1.ensureOrganizationIds)((options?.filter ?? {}));
+    return {
+        pageNumber,
+        pageSize,
+        ...(sortBy ? { sortBy } : {}),
+        ...(sortType ? { sortType } : {}),
+        filter: filter,
+    };
+}
+function buildCasesGetActivitiesQuery(options) {
+    return {
+        pageNumber: options.pageNumber ?? 1,
+        pageSize: options.pageSize ?? 10,
+        filter: (options.filter ?? {}),
+    };
+}
+function buildCasesGetEndpointsQuery(options) {
+    const filter = (0, utils_1.ensureOrganizationIds)((options.filter ?? {}));
+    return {
+        pageNumber: options.pageNumber ?? 1,
+        pageSize: options.pageSize ?? 10,
+        filter,
+    };
+}
+function buildCasesGetTasksQuery(options) {
+    return {
+        pageNumber: options.pageNumber ?? 1,
+        pageSize: options.pageSize ?? 10,
+        filter: (options.filter ?? {}),
+    };
+}
+function buildCasesGetUsersQuery(options) {
+    const filter = (0, utils_1.ensureOrganizationIds)((options.filter ?? {}));
+    return {
+        pageNumber: options.pageNumber ?? 1,
+        pageSize: options.pageSize ?? 10,
+        filter,
+    };
+}
+//# sourceMappingURL=builders.js.map

package/dist/utils/builders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"builders.js","sourceRoot":"","sources":["../../src/utils/builders.ts"],"names":[],"mappings":";;AAkBA,0DAgBC;AAED,4DAcC;AAGD,wDAgBC;AAED,oEAUC;AAED,kEAcC;AAED,0DAUC;AAED,0DAcC;AA9GD,mCAAgD;AAEhD,kBAAkB;AAClB,SAAgB,uBAAuB,CAAC,OAA2B;IACjE,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;IACzC,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;IAC/B,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;IACnC,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAClC,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAA+E,CAC7D,CAAC;IAE3C,OAAO;QACL,UAAU;QACV,QAAQ;QACR,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7B,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,MAAM,EAAE,MAA8C;KACzB,CAAC;AAClC,CAAC;AAED,SAAgB,wBAAwB,CAAC,OAA8B;IACrE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC;IACxC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAClC,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAA0C,CAAC;IAE/E,OAAO;QACL,UAAU;QACV,QAAQ;QACR,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7B,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,MAAM;KACwB,CAAC;AACnC,CAAC;AAED,iBAAiB;AACjB,SAAgB,sBAAsB,CAAC,OAA0B;IAC/D,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;IACzC,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;IAC/B,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;IACnC,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAClC,CAAC,OAAO,EAAE,MAAM,IAAI,EAAE,CAA8E,CAC7D,CAAC;IAE1C,OAAO;QACL,UAAU;QACV,QAAQ;QACR,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7B,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,MAAM,EAAE,MAA6C;KACzB,CAAC;AACjC,CAAC;AAED,SAAgB,4BAA4B,CAAC,OAI5C;IACC,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,CAAC;QACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;QAChC,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAA8C;KACzC,CAAC;AACvC,CAAC;AAED,SAAgB,2BAA2B,CAAC,OAI3C;IACC,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAClC,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAqG,CAC/E,CAAC;IAE9C,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,CAAC;QACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;QAChC,MAAM;KAC2B,CAAC;AACtC,CAAC;AAED,SAAgB,uBAAuB,CAAC,OAIvC;IACC,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,CAAC;QACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;QAChC,MAAM,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAyC;KACzC,CAAC;AAClC,CAAC;AAED,SAAgB,uBAAuB,CAAC,OAIvC;IACC,MAAM,MAAM,GAAG,IAAA,6BAAqB,EAClC,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAiG,CAC/E,CAAC;IAE1C,OAAO;QACL,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,CAAC;QACnC,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;QAChC,MAAM;KACuB,CAAC;AAClC,CAAC"}

package/dist/utils/error-helpers.d.ts

@@ -0,0 +1,6 @@
+export declare function extractErrorMessage(error: unknown, defaultMessage?: string): string;
+export declare function extractStatusCode(error: unknown, defaultStatus?: number): number;
+export declare function isNotFoundError(error: unknown): boolean;
+export declare function isSuccessStatus(status: number): boolean;
+export declare function isSuccessPayloadOrStatus(payload: unknown, status: number): boolean;
+export declare function extractMessage(payload: unknown, defaultMessage?: string): string;

package/dist/utils/error-helpers.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractErrorMessage = extractErrorMessage;
+exports.extractStatusCode = extractStatusCode;
+exports.isNotFoundError = isNotFoundError;
+exports.isSuccessStatus = isSuccessStatus;
+exports.isSuccessPayloadOrStatus = isSuccessPayloadOrStatus;
+exports.extractMessage = extractMessage;
+/*
+    Error handling utilities for safe error extraction and formatting.
+    These utilities follow TypeScript best practices by treating caught errors as unknown.
+*/
+function messageFromUnknown(input, fallback) {
+    if (input instanceof Error) {
+        return input.message;
+    }
+    if (typeof input === 'string') {
+        return input;
+    }
+    if (input && typeof input === 'object') {
+        const anyObj = input;
+        if ('message' in anyObj && typeof anyObj.message === 'string') {
+            return anyObj.message;
+        }
+        if ('error' in anyObj && anyObj.error && typeof anyObj.error === 'object') {
+            const inner = anyObj.error;
+            if ('message' in inner && typeof inner.message === 'string') {
+                return inner.message;
+            }
+        }
+        if ('response' in anyObj && anyObj.response && typeof anyObj.response === 'object') {
+            const responseObj = anyObj.response;
+            if ('data' in responseObj) {
+                return messageFromUnknown(responseObj.data, fallback);
+            }
+        }
+    }
+    if (Array.isArray(input) && input.length > 0) {
+        return String(input[0]);
+    }
+    if (input && typeof input === 'object') {
+        try {
+            return JSON.stringify(input);
+        }
+        catch {
+            return fallback;
+        }
+    }
+    return fallback;
+}
+function extractErrorMessage(error, defaultMessage = 'An unknown error occurred') {
+    return messageFromUnknown(error, defaultMessage);
+}
+/*
+    Extracts a status code from an unknown error value.
+    Checks common locations where status codes might be stored in API errors.
+*/
+function extractStatusCode(error, defaultStatus = 500) {
+    if (!error || typeof error !== 'object') {
+        return defaultStatus;
+    }
+    const errorObj = error;
+    // Check direct status property
+    if ('status' in errorObj && typeof errorObj.status === 'number') {
+        return errorObj.status;
+    }
+    // Check statusCode property
+    if ('statusCode' in errorObj && typeof errorObj.statusCode === 'number') {
+        return errorObj.statusCode;
+    }
+    // Check response.status
+    if ('response' in errorObj) {
+        const response = errorObj.response;
+        if (response && typeof response === 'object') {
+            const responseObj = response;
+            if ('status' in responseObj && typeof responseObj.status === 'number') {
+                return responseObj.status;
+            }
+            if ('statusCode' in responseObj && typeof responseObj.statusCode === 'number') {
+                return responseObj.statusCode;
+            }
+        }
+    }
+    return defaultStatus;
+}
+// Checks if an error represents a not found (404) status.
+function isNotFoundError(error) {
+    const status = extractStatusCode(error);
+    return status === 404;
+}
+// Checks if an error represents a successful HTTP response (2xx).
+function isSuccessStatus(status) {
+    return status >= 200 && status < 300;
+}
+// Determines success using a payload's explicit success flag or falls back to status code.
+function isSuccessPayloadOrStatus(payload, status) {
+    if (payload && typeof payload === 'object') {
+        const record = payload;
+        if (typeof record.success === 'boolean') {
+            return record.success;
+        }
+    }
+    return isSuccessStatus(status);
+}
+// Extracts error/validation message from various API response shapes.
+function extractMessage(payload, defaultMessage = 'Validation failed') {
+    return messageFromUnknown(payload, defaultMessage);
+}
+//# sourceMappingURL=error-helpers.js.map

package/dist/utils/error-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-helpers.js","sourceRoot":"","sources":["../../src/utils/error-helpers.ts"],"names":[],"mappings":";;AAkDA,kDAEC;AAMD,8CAgCC;AAGD,0CAGC;AAGD,0CAEC;AAGD,4DAQC;AAGD,wCAEC;AArHD;;;EAGE;AACF,SAAS,kBAAkB,CAAC,KAAc,EAAE,QAAgB;IAC1D,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,OAAO,CAAC;IACvB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,KAAgC,CAAC;QAEhD,IAAI,SAAS,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC9D,OAAO,MAAM,CAAC,OAAO,CAAC;QACxB,CAAC;QAED,IAAI,OAAO,IAAI,MAAM,IAAI,MAAM,CAAC,KAAK,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC1E,MAAM,KAAK,GAAG,MAAM,CAAC,KAAgC,CAAC;YACtD,IAAI,SAAS,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC5D,OAAO,KAAK,CAAC,OAAO,CAAC;YACvB,CAAC;QACH,CAAC;QAED,IAAI,UAAU,IAAI,MAAM,IAAI,MAAM,CAAC,QAAQ,IAAI,OAAO,MAAM,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACnF,MAAM,WAAW,GAAG,MAAM,CAAC,QAAmC,CAAC;YAC/D,IAAI,MAAM,IAAI,WAAW,EAAE,CAAC;gBAC1B,OAAO,kBAAkB,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7C,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAgB,mBAAmB,CAAC,KAAc,EAAE,cAAc,GAAG,2BAA2B;IAC9F,OAAO,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;AACnD,CAAC;AAED;;;EAGE;AACF,SAAgB,iBAAiB,CAAC,KAAc,EAAE,aAAa,GAAG,GAAG;IACnE,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,QAAQ,GAAG,KAAgC,CAAC;IAElD,+BAA+B;IAC/B,IAAI,QAAQ,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;QAChE,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED,4BAA4B;IAC5B,IAAI,YAAY,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;QACxE,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC7B,CAAC;IAED,wBAAwB;IACxB,IAAI,UAAU,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QACnC,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC7C,MAAM,WAAW,GAAG,QAAmC,CAAC;YACxD,IAAI,QAAQ,IAAI,WAAW,IAAI,OAAO,WAAW,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACtE,OAAO,WAAW,CAAC,MAAM,CAAC;YAC5B,CAAC;YACD,IAAI,YAAY,IAAI,WAAW,IAAI,OAAO,WAAW,CAAC,UAAU,KAAK,QAAQ,EAAE,CAAC;gBAC9E,OAAO,WAAW,CAAC,UAAU,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,aAAa,CAAC;AACvB,CAAC;AAED,0DAA0D;AAC1D,SAAgB,eAAe,CAAC,KAAc;IAC5C,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACxC,OAAO,MAAM,KAAK,GAAG,CAAC;AACxB,CAAC;AAED,kEAAkE;AAClE,SAAgB,eAAe,CAAC,MAAc;IAC5C,OAAO,MAAM,IAAI,GAAG,IAAI,MAAM,GAAG,GAAG,CAAC;AACvC,CAAC;AAED,2FAA2F;AAC3F,SAAgB,wBAAwB,CAAC,OAAgB,EAAE,MAAc;IACvE,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC3C,MAAM,MAAM,GAAG,OAAkC,CAAC;QAClD,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACxC,OAAO,MAAM,CAAC,OAAO,CAAC;QACxB,CAAC;IACH,CAAC;IACD,OAAO,eAAe,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED,sEAAsE;AACtE,SAAgB,cAAc,CAAC,OAAgB,EAAE,cAAc,GAAG,mBAAmB;IACnF,OAAO,kBAAkB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;AACrD,CAAC"}

package/dist/utils/index.d.ts

@@ -1 +1,4 @@
 export * from './utils';
+export * from './error-helpers';
+export * from './builders';
+export * from './result';

package/dist/utils/index.js

@@ -15,4 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./utils"), exports);
+__exportStar(require("./error-helpers"), exports);
+__exportStar(require("./builders"), exports);
+__exportStar(require("./result"), exports);
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,kDAAgC;AAChC,6CAA2B;AAC3B,2CAAyB"}

package/dist/utils/result.d.ts

@@ -0,0 +1,2 @@
+import type { Result } from '../types';
+export declare function toResult<T>(fn: () => Promise<T>, defaultErrorMessage?: string): Promise<Result<T>>;

package/dist/utils/result.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toResult = toResult;
+const error_helpers_1 = require("./error-helpers");
+async function toResult(fn, defaultErrorMessage = 'Operation failed') {
+    try {
+        const data = await fn();
+        return { success: true, result: data, statusCode: 200 };
+    }
+    catch (error) {
+        return {
+            success: false,
+            result: null,
+            statusCode: (0, error_helpers_1.extractStatusCode)(error, 500),
+            message: (0, error_helpers_1.extractErrorMessage)(error) || defaultErrorMessage,
+        };
+    }
+}
+//# sourceMappingURL=result.js.map

package/dist/utils/result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.js","sourceRoot":"","sources":["../../src/utils/result.ts"],"names":[],"mappings":";;AAGA,4BAaC;AAfD,mDAAyE;AAElE,KAAK,UAAU,QAAQ,CAAI,EAAoB,EAAE,mBAAmB,GAAG,kBAAkB;IAE9F,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,EAAE,EAAE,CAAC;QACxB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,OAAO;YACL,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,IAAA,iCAAiB,EAAC,KAAK,EAAE,GAAG,CAAC;YACzC,OAAO,EAAE,IAAA,mCAAmB,EAAC,KAAK,CAAC,IAAI,mBAAmB;SAC3D,CAAC;IACJ,CAAC;AACH,CAAC"}