griddo-sdk 2.1.0-rc.2 → 2.1.0

package/dist/interfaces/ActivityLog.d.ts

@@ -0,0 +1,67 @@
+import type { ExportResponse, LogActivityDTO, LogActivityExportRequest, LogActivityGroupedDayDTO, LogActivityGroupedUserDTO, LogActivityPaginationRequest, PaginationResponse } from "@griddo/api-types";
+import type { LogActivityEventDTO } from "@griddo/api-types/dist/logs/activity_events";
+/**
+ * Interface for the ActivityLog operations exposed by the SDK.
+ *
+ * Defines the contract for querying and exporting superadmin activity logs:
+ * a timeline view, two grouped views (by user and by day), and their
+ * corresponding export endpoints, plus the catalog of available event types.
+ */
+export interface ActivityLogManager {
+    /**
+     * Retrieves a paginated list of activity log entries.
+     *
+     * @param params - The query parameters for pagination and filtering.
+     * @returns A promise that resolves with the paginated activity log entries.
+     * @throws If the HTTP response is not successful or if the response format is incorrect.
+     */
+    timeline(params?: LogActivityPaginationRequest): Promise<PaginationResponse<LogActivityDTO>>;
+    /**
+     * Retrieves a paginated list of activity log entries grouped by user.
+     *
+     * @param params - The query parameters for pagination and filtering.
+     * @returns A promise that resolves with the paginated grouped activity log entries.
+     * @throws If the HTTP response is not successful or if the response format is incorrect.
+     */
+    groupedByUser<TLogActivity = LogActivityDTO[]>(params?: LogActivityPaginationRequest): Promise<PaginationResponse<LogActivityGroupedUserDTO<TLogActivity>>>;
+    /**
+     * Retrieves a paginated list of activity log entries grouped by day.
+     *
+     * @param params - The query parameters for pagination and filtering.
+     * @returns A promise that resolves with the paginated grouped activity log entries.
+     * @throws If the HTTP response is not successful or if the response format is incorrect.
+     */
+    groupedByDay(params?: LogActivityPaginationRequest): Promise<PaginationResponse<LogActivityGroupedDayDTO>>;
+    /**
+     * Exports the activity log timeline in one or more formats.
+     *
+     * @param body - The export options (formats, date range, optional start time and max events).
+     * @returns A promise that resolves with the export response.
+     * @throws If the HTTP response is not successful or if the response format is incorrect.
+     */
+    exportTimeline(body: LogActivityExportRequest): Promise<ExportResponse>;
+    /**
+     * Exports the activity log grouped by user in one or more formats.
+     *
+     * @param body - The export options (formats, date range, optional start time and max events).
+     * @returns A promise that resolves with the export response.
+     * @throws If the HTTP response is not successful or if the response format is incorrect.
+     */
+    exportGroupedByUser(body: LogActivityExportRequest): Promise<ExportResponse>;
+    /**
+     * Exports the activity log grouped by day in one or more formats.
+     *
+     * @param body - The export options (formats, date range, optional start time and max events).
+     * @returns A promise that resolves with the export response.
+     * @throws If the HTTP response is not successful or if the response format is incorrect.
+     */
+    exportGroupedByDay(body: LogActivityExportRequest): Promise<ExportResponse>;
+    /**
+     * Retrieves the catalog of available activity log event types.
+     *
+     * @returns A promise that resolves with the list of event types.
+     * @throws If the HTTP response is not successful or if the response format is incorrect.
+     */
+    fetchEventTypes(): Promise<LogActivityEventDTO[]>;
+}
+//# sourceMappingURL=ActivityLog.d.ts.map

package/dist/interfaces/ActivityLog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityLog.d.ts","sourceRoot":"","sources":["../../src/interfaces/ActivityLog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,kBAAkB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AAEvF;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;;OAMG;IACH,QAAQ,CACP,MAAM,CAAC,EAAE,4BAA4B,GACnC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,aAAa,CAAC,YAAY,GAAG,cAAc,EAAE,EAC5C,MAAM,CAAC,EAAE,4BAA4B,GACnC,OAAO,CAAC,kBAAkB,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAExE;;;;;;OAMG;IACH,YAAY,CACX,MAAM,CAAC,EAAE,4BAA4B,GACnC,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAEzD;;;;;;OAMG;IACH,cAAc,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAExE;;;;;;OAMG;IACH,mBAAmB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7E;;;;;;OAMG;IACH,kBAAkB,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE5E;;;;;OAKG;IACH,eAAe,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAC;CAClD"}

package/dist/services/ActivityLogService.d.ts

@@ -0,0 +1,18 @@
+import type { ApiService } from "./ApiService";
+import type { ExportResponse, LogActivityDTO, LogActivityExportRequest, LogActivityGroupedDayDTO, LogActivityGroupedUserDTO, LogActivityPaginationRequest, PaginationResponse } from "@griddo/api-types";
+import type { LogActivityEventDTO } from "@griddo/api-types/dist/logs/activity_events";
+import type { ActivityLogManager } from "../interfaces/ActivityLog";
+export declare class ActivityLogService implements ActivityLogManager {
+    private readonly apiService;
+    constructor(apiService: ApiService);
+    timeline(params?: LogActivityPaginationRequest): Promise<PaginationResponse<LogActivityDTO>>;
+    groupedByUser<TLogActivity = LogActivityDTO[]>(params?: LogActivityPaginationRequest): Promise<PaginationResponse<LogActivityGroupedUserDTO<TLogActivity>>>;
+    groupedByDay(params?: LogActivityPaginationRequest): Promise<PaginationResponse<LogActivityGroupedDayDTO>>;
+    exportTimeline(body: LogActivityExportRequest): Promise<ExportResponse>;
+    exportGroupedByUser(body: LogActivityExportRequest): Promise<ExportResponse>;
+    exportGroupedByDay(body: LogActivityExportRequest): Promise<ExportResponse>;
+    fetchEventTypes(): Promise<LogActivityEventDTO[]>;
+    private buildEndpoint;
+    private toQueryString;
+}
+//# sourceMappingURL=ActivityLogService.d.ts.map

package/dist/services/ActivityLogService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityLogService.d.ts","sourceRoot":"","sources":["../../src/services/ActivityLogService.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EACX,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,wBAAwB,EACxB,yBAAyB,EACzB,4BAA4B,EAC5B,kBAAkB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AAEvF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAMlE,qBAAa,kBAAmB,YAAW,kBAAkB;IAC5D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;gBAE5B,UAAU,EAAE,UAAU;IAYrB,QAAQ,CACpB,MAAM,CAAC,EAAE,4BAA4B,GACnC,OAAO,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;IAOjC,aAAa,CAAC,YAAY,GAAG,cAAc,EAAE,EACzD,MAAM,CAAC,EAAE,4BAA4B,GACnC,OAAO,CAAC,kBAAkB,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC,CAAC;IAS1D,YAAY,CACxB,MAAM,CAAC,EAAE,4BAA4B,GACnC,OAAO,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;IAO3C,cAAc,CAC1B,IAAI,EAAE,wBAAwB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAQb,mBAAmB,CAC/B,IAAI,EAAE,wBAAwB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAQb,kBAAkB,CAC9B,IAAI,EAAE,wBAAwB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAQb,eAAe,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAO9D,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,aAAa;CA0BrB"}

package/package.json

@@ -1,14 +1,10 @@
 {
 	"name": "griddo-sdk",
-	"version": "2.1.0-rc.2",
+	"version": "2.1.0",
 	"descripcion": "Griddo SDK es una biblioteca que facilita la integración con la API de Griddo, permitiendo a los desarrolladores conectarse, realizar consultas estructuradas de datos con facilidad. Este SDK proporciona métodos sencillos para interactuar con los diferentes servicios de Griddo, manejando detalles como la autenticación y la paginación de resultados, y permitiendo personalizar consultas con diversos parámetros.",
 	"main": "dist/index.js",
-	"bin": {
-		"griddo": "./dist/cli.js"
-	},
 	"scripts": {
 		"build": "node scripts/build.cjs && tsc --emitDeclarationOnly && tsc-alias",
-		"build:cli": "node scripts/build-cli.cjs",
 		"build:tsc": "esbuild src/index.ts --bundle --platform=node --minify --outfile=./dist/index.js && tsc --emitDeclarationOnly",
 		"build:examples": "esbuild examples/*.ts --bundle --platform=node --outdir=dist/examples && tsc --emitDeclarationOnly",
 		"build:doc": "npx typedoc",
@@ -20,7 +16,7 @@
 		"lint:fix": "eslint --fix 'src/**/*.{ts,js}'",
 		"prettier": "prettier --write 'src/**/*.{js,ts}'",
 		"release": "release-it",
-		"run:example": "node examples/run_example.js pages/get_ids",
+		"run:example": "node examples/run_example.js activity-log/fetch_event_types",
 		"test": "vitest",
 		"test:sync": "vitest --pool=forks --no-file-parallelism",
 		"test:coverage": "npx vitest run --coverage",
@@ -61,7 +57,6 @@
 		"@typescript-eslint/parser": "^8.23.0",
 		"@vitest/coverage-v8": "^3.0.7",
 		"@vitest/ui": "^3.0.7",
-		"commander": "^14.0.3",
 		"dotenv": "^16.4.5",
 		"esbuild": "^0.25.0",
 		"esbuild-plugin-alias": "^0.2.1",

package/dist/cli/bin.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=bin.d.ts.map

package/dist/cli/bin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../../src/cli/bin.ts"],"names":[],"mappings":""}

package/dist/cli/commands/alerts.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerAlertsCommands(parent: Command): void;
-//# sourceMappingURL=alerts.d.ts.map

package/dist/cli/commands/alerts.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/alerts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CA4D5D"}

package/dist/cli/commands/api.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerApiCommands(parent: Command): void;
-//# sourceMappingURL=api.d.ts.map

package/dist/cli/commands/api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAkBzC,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAkCzD"}

package/dist/cli/commands/data.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerDataCommands(parent: Command): void;
-//# sourceMappingURL=data.d.ts.map

package/dist/cli/commands/data.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAqH1D"}

package/dist/cli/commands/images.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerImagesCommands(parent: Command): void;
-//# sourceMappingURL=images.d.ts.map

package/dist/cli/commands/images.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/images.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAkJ5D"}

package/dist/cli/commands/languages.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerLanguagesCommands(parent: Command): void;
-//# sourceMappingURL=languages.d.ts.map

package/dist/cli/commands/languages.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/languages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAIzC,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAkD/D"}

package/dist/cli/commands/live-status.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerLiveStatusCommands(parent: Command): void;
-//# sourceMappingURL=live-status.d.ts.map

package/dist/cli/commands/live-status.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"live-status.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/live-status.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAsDhE"}

package/dist/cli/commands/pages.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerPagesCommands(parent: Command): void;
-//# sourceMappingURL=pages.d.ts.map

package/dist/cli/commands/pages.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pages.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/pages.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAiI3D"}

package/dist/cli/commands/site.d.ts

@@ -1,3 +0,0 @@
-import type { Command } from "commander";
-export declare function registerSiteCommands(parent: Command): void;
-//# sourceMappingURL=site.d.ts.map

package/dist/cli/commands/site.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../src/cli/commands/site.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CA8F1D"}

package/dist/cli/input.d.ts

@@ -1,4 +0,0 @@
-export declare function readInput(filePath?: string): Promise<string>;
-export declare function parseJSONInput(filePath?: string): Promise<unknown>;
-export declare function parseJSONObject(filePath?: string, label?: string): Promise<Record<string, unknown>>;
-//# sourceMappingURL=input.d.ts.map

package/dist/cli/input.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/cli/input.ts"],"names":[],"mappings":"AAaA,wBAAsB,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAoBlE;AAED,wBAAsB,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAUxE;AAED,wBAAsB,eAAe,CACpC,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,SAAU,GACb,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAUlC"}

package/dist/cli/output.d.ts

@@ -1,5 +0,0 @@
-export declare function outputJSON(data: unknown, opts: {
-    format?: string;
-}): void;
-export declare function outputError(error: unknown): void;
-//# sourceMappingURL=output.d.ts.map

package/dist/cli/output.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../src/cli/output.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,CACzB,IAAI,EAAE,OAAO,EACb,IAAI,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GACvB,IAAI,CAGN;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAgBhD"}

package/dist/cli/program.d.ts

@@ -1,3 +0,0 @@
-import { Command } from "commander";
-export declare function createProgram(): Command;
-//# sourceMappingURL=program.d.ts.map

package/dist/cli/program.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"program.d.ts","sourceRoot":"","sources":["../../src/cli/program.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAUpC,wBAAgB,aAAa,IAAI,OAAO,CAqBvC"}

package/dist/cli/sdk-factory.d.ts

@@ -1,6 +0,0 @@
-import { SDK } from "../index";
-export declare function createSDK(globalOpts: {
-    verbose?: boolean;
-    silent?: boolean;
-}): SDK;
-//# sourceMappingURL=sdk-factory.d.ts.map

package/dist/cli/sdk-factory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sdk-factory.d.ts","sourceRoot":"","sources":["../../src/cli/sdk-factory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAyB/B,wBAAgB,SAAS,CAAC,UAAU,EAAE;IACrC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,GAAG,GAAG,CAqCN"}