@trokky/trokky 2.0.3

package/dist/types/api-requests.d.ts

@@ -0,0 +1,334 @@
+/**
+ * @trokky/types - API Request Types
+ *
+ * Request and response types for Trokky API endpoints.
+ * These types define the contract for document, media, user, and other operations.
+ */
+/**
+ * Request to list documents in a collection
+ */
+export interface ListDocumentsRequest {
+    /** Collection name */
+    collection: string;
+    /** Maximum number of documents to return */
+    limit?: number;
+    /** Number of documents to skip */
+    offset?: number;
+    /** Filter criteria */
+    filter?: Record<string, unknown>;
+    /** Sort field(s) */
+    sort?: string | string[];
+}
+/**
+ * Request to create a new document
+ */
+export interface CreateDocumentRequest {
+    /** Collection name */
+    collection: string;
+    /** Document data */
+    data: Record<string, unknown>;
+    /** Optional custom document ID */
+    id?: string;
+}
+/**
+ * Request to update an existing document
+ */
+export interface UpdateDocumentRequest {
+    /** Collection name */
+    collection: string;
+    /** Document ID */
+    id: string;
+    /** Partial document data to update */
+    data: Record<string, unknown>;
+}
+/**
+ * Request to get a single document
+ */
+export interface GetDocumentRequest {
+    /** Collection name */
+    collection: string;
+    /** Document ID */
+    id: string;
+}
+/**
+ * Request to delete a document
+ */
+export interface DeleteDocumentRequest {
+    /** Collection name */
+    collection: string;
+    /** Document ID */
+    id: string;
+}
+/**
+ * Request to upload media files
+ */
+export interface UploadMediaRequest {
+    /** Files to upload */
+    files: File[];
+    /** Optional metadata for the uploaded files */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Request to get a media file
+ */
+export interface GetMediaRequest {
+    /** Media file ID */
+    id: string;
+}
+/**
+ * Request to delete a media file
+ */
+export interface DeleteMediaRequest {
+    /** Media file ID */
+    id: string;
+}
+/**
+ * Request to list users
+ */
+export interface ListUsersRequest {
+    /** Filter by role */
+    role?: string;
+    /** Filter by active status */
+    isActive?: boolean;
+    /** Maximum number of users to return */
+    limit?: number;
+    /** Number of users to skip */
+    offset?: number;
+}
+/**
+ * Request to create a new user
+ */
+export interface CreateUserRequest {
+    /** User data for creation */
+    userData: {
+        username: string;
+        email: string;
+        password: string;
+        firstName: string;
+        lastName: string;
+        role: string;
+        permissions?: string[];
+        isActive?: boolean;
+    };
+}
+/**
+ * Request to update an existing user
+ */
+export interface UpdateUserRequest {
+    /** User ID */
+    id: string;
+    /** Partial user data to update */
+    userData: {
+        username?: string;
+        email?: string;
+        firstName?: string;
+        lastName?: string;
+        role?: string;
+        permissions?: string[];
+        isActive?: boolean;
+    };
+}
+/**
+ * Request to get a single user
+ */
+export interface GetUserRequest {
+    /** User ID */
+    id: string;
+}
+/**
+ * Request to delete a user
+ */
+export interface DeleteUserRequest {
+    /** User ID */
+    id: string;
+}
+/**
+ * Request to get a user by username
+ */
+export interface GetUserByUsernameRequest {
+    /** Username to search for */
+    username: string;
+}
+/**
+ * Request to get a user by email
+ */
+export interface GetUserByEmailRequest {
+    /** Email to search for */
+    email: string;
+}
+/**
+ * Login request
+ */
+export interface LoginRequest {
+    /** Username */
+    username: string;
+    /** Password */
+    password: string;
+    /** Whether to create a long-lived session */
+    rememberMe?: boolean;
+    /** Device identifier for trusted device tracking */
+    deviceId?: string;
+    /** CAPTCHA token for bot protection */
+    captchaToken?: string;
+}
+/**
+ * Login response
+ */
+export interface LoginResponse {
+    /** Whether login was successful */
+    success: boolean;
+    /** JWT access token */
+    token?: string;
+    /** JWT refresh token */
+    refreshToken?: string;
+    /** Authenticated user (without sensitive fields) */
+    user?: {
+        id: string;
+        username: string;
+        email: string;
+        firstName: string;
+        lastName: string;
+        role: string;
+        permissions: string[];
+        isActive: boolean;
+    };
+    /** Token expiration timestamp */
+    expiresAt?: string;
+}
+/**
+ * Logout request
+ */
+export interface LogoutRequest {
+    /** Token to invalidate (optional) */
+    token?: string;
+}
+/**
+ * Token validation request
+ */
+export interface ValidateTokenRequest {
+    /** Token to validate */
+    token: string;
+}
+/**
+ * Token refresh request
+ */
+export interface RefreshTokenRequest {
+    /** Refresh token */
+    refreshToken: string;
+}
+/**
+ * Request to check slug uniqueness
+ */
+export interface CheckSlugUniquenessRequest {
+    /** Slug to check */
+    slug: string;
+    /** Collection to check within */
+    collection: string;
+    /** Document ID to exclude (for updates) */
+    excludeId?: string;
+}
+/**
+ * Response for slug uniqueness check
+ */
+export interface CheckSlugUniquenessResponse {
+    /** Whether the slug is unique */
+    unique: boolean;
+    /** The checked slug */
+    slug: string;
+    /** The collection checked */
+    collection: string;
+    /** Reason if not unique */
+    reason?: string;
+}
+/**
+ * Request to list webhooks
+ */
+export interface ListWebhooksRequest {
+    /** Filter by active status */
+    active?: boolean;
+    /** Maximum number of webhooks to return */
+    limit?: number;
+    /** Number of webhooks to skip */
+    offset?: number;
+}
+/**
+ * Retry policy configuration for webhooks
+ */
+export interface WebhookRetryPolicy {
+    /** Maximum number of retry attempts */
+    maxRetries: number;
+    /** Type of backoff strategy */
+    backoffType: 'linear' | 'exponential';
+    /** Base delay in milliseconds */
+    baseDelay: number;
+    /** Maximum delay in milliseconds */
+    maxDelay: number;
+    /** HTTP status codes that trigger a retry */
+    retryOnStatus: number[];
+}
+/**
+ * Request to create a webhook
+ */
+export interface CreateWebhookRequest {
+    /** Webhook configuration data */
+    webhookData: {
+        name: string;
+        url: string;
+        events: string[];
+        secret?: string;
+        active?: boolean;
+        headers?: Record<string, string>;
+        retryPolicy?: WebhookRetryPolicy;
+    };
+}
+/**
+ * Request to update a webhook
+ */
+export interface UpdateWebhookRequest {
+    /** Webhook ID */
+    id: string;
+    /** Partial webhook data to update */
+    webhookData: {
+        name?: string;
+        url?: string;
+        events?: string[];
+        secret?: string;
+        active?: boolean;
+        headers?: Record<string, string>;
+    };
+}
+/**
+ * Request to get a webhook
+ */
+export interface GetWebhookRequest {
+    /** Webhook ID */
+    id: string;
+}
+/**
+ * Request to delete a webhook
+ */
+export interface DeleteWebhookRequest {
+    /** Webhook ID */
+    id: string;
+}
+/**
+ * Request to get webhook delivery history
+ */
+export interface GetWebhookDeliveriesRequest {
+    /** Webhook ID */
+    id: string;
+    /** Maximum number of deliveries to return */
+    limit?: number;
+    /** Number of deliveries to skip */
+    offset?: number;
+}
+/**
+ * Request to test a webhook
+ */
+export interface TestWebhookRequest {
+    /** Webhook ID */
+    id: string;
+    /** Event type to simulate */
+    eventType?: string;
+}
+//# sourceMappingURL=api-requests.d.ts.map

package/dist/types/api-requests.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-requests.d.ts","sourceRoot":"","sources":["../../src/types/api-requests.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,kCAAkC;IAClC,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAA;IACV,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAA;CACX;AAMD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,oBAAoB;IACpB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,oBAAoB;IACpB,EAAE,EAAE,MAAM,CAAA;CACX;AAMD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,8BAA8B;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,QAAQ,EAAE;QACR,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAA;KACnB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc;IACd,EAAE,EAAE,MAAM,CAAA;IACV,kCAAkC;IAClC,QAAQ,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;QACtB,QAAQ,CAAC,EAAE,OAAO,CAAA;KACnB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc;IACd,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc;IACd,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAA;CACd;AAMD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,eAAe;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,uCAAuC;IACvC,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,uBAAuB;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,wBAAwB;IACxB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,oDAAoD;IACpD,IAAI,CAAC,EAAE;QACL,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,MAAM,EAAE,CAAA;QACrB,QAAQ,EAAE,OAAO,CAAA;KAClB,CAAA;IACD,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,oBAAoB;IACpB,YAAY,EAAE,MAAM,CAAA;CACrB;AAMD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,iCAAiC;IACjC,MAAM,EAAE,OAAO,CAAA;IACf,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAA;IAClB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,8BAA8B;IAC9B,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,+BAA+B;IAC/B,WAAW,EAAE,QAAQ,GAAG,aAAa,CAAA;IACrC,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAA;QACZ,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAChC,WAAW,CAAC,EAAE,kBAAkB,CAAA;KACjC,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,qCAAqC;IACrC,WAAW,EAAE;QACX,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;QACjB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACjC,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}

package/dist/types/api-requests.js

@@ -0,0 +1,8 @@
+/**
+ * @trokky/types - API Request Types
+ *
+ * Request and response types for Trokky API endpoints.
+ * These types define the contract for document, media, user, and other operations.
+ */
+export {};
+//# sourceMappingURL=api-requests.js.map

package/dist/types/api-requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-requests.js","sourceRoot":"","sources":["../../src/types/api-requests.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}