@gaganref/convex-api-keys 0.1.0

package/dist/component/cleanup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanup.js","sourceRoot":"","sources":["../../src/component/cleanup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAC1C,OAAO,EAAE,CAAC,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG/C,MAAM,UAAU,GAAG,GAAG,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,QAAQ,CAAC;IACrC,IAAI,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE;IACjC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;KACpB,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;QACtC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,WAAW,IAAI,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,WAAW,CAAC;gBACpB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,qDAAqD,WAAW,EAAE;aAC5E,CAAC,CAAC;QACL,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC;QAExC,wEAAwE;QACxE,8DAA8D;QAC9D,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,EAAE;aAC7B,KAAK,CAAC,SAAS,CAAC;aAChB,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CAChC,CAAC,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAC9C;aACA,IAAI,CAAC,UAAU,CAAC,CAAC;QAEpB,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;YAC9B,MAAM,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC;QACnC,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,UAAU,CAAC;QAE/C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,cAAc,EAAE;gBAC1D,WAAW;aACZ,CAAC,CAAC;QACL,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC7B,CAAC;CACF,CAAC,CAAC;AAEH,KAAK,UAAU,kBAAkB,CAC/B,GAAgB,EAChB,KAAoB;IAEpB,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,EAAE;SACxB,KAAK,CAAC,cAAc,CAAC;SACrB,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SACnD,OAAO,EAAE,CAAC;IACb,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC"}

package/dist/component/convex.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("convex/server").ComponentDefinition<any>;
+export default _default;
+//# sourceMappingURL=convex.config.d.ts.map

package/dist/component/convex.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convex.config.d.ts","sourceRoot":"","sources":["../../src/component/convex.config.ts"],"names":[],"mappings":";AAEA,wBAA0C"}

package/dist/component/convex.config.js

@@ -0,0 +1,3 @@
+import { defineComponent } from "convex/server";
+export default defineComponent("apiKeys");
+//# sourceMappingURL=convex.config.js.map

package/dist/component/convex.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convex.config.js","sourceRoot":"","sources":["../../src/component/convex.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,eAAe,eAAe,CAAC,SAAS,CAAC,CAAC"}

package/dist/component/crons.d.ts

@@ -0,0 +1,3 @@
+declare const crons: import("convex/server").Crons;
+export default crons;
+//# sourceMappingURL=crons.d.ts.map

package/dist/component/crons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crons.d.ts","sourceRoot":"","sources":["../../src/component/crons.ts"],"names":[],"mappings":"AAGA,QAAA,MAAM,KAAK,+BAAa,CAAC;AAgBzB,eAAe,KAAK,CAAC"}

package/dist/component/crons.js

@@ -0,0 +1,7 @@
+import { cronJobs } from "convex/server";
+import { internal } from "./_generated/api.js";
+const crons = cronJobs();
+crons.interval("sweep expired api keys", { hours: 1 }, internal.sweep.sweepExpired, {});
+crons.interval("sweep idle expired api keys", { hours: 1 }, internal.sweep.sweepIdleExpired, {});
+export default crons;
+//# sourceMappingURL=crons.js.map

package/dist/component/crons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crons.js","sourceRoot":"","sources":["../../src/component/crons.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAE/C,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;AAEzB,KAAK,CAAC,QAAQ,CACZ,wBAAwB,EACxB,EAAE,KAAK,EAAE,CAAC,EAAE,EACZ,QAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,EAAE,CACH,CAAC;AAEF,KAAK,CAAC,QAAQ,CACZ,6BAA6B,EAC7B,EAAE,KAAK,EAAE,CAAC,EAAE,EACZ,QAAQ,CAAC,KAAK,CAAC,gBAAgB,EAC/B,EAAE,CACH,CAAC;AAEF,eAAe,KAAK,CAAC"}

package/dist/component/lib.d.ts

@@ -0,0 +1,323 @@
+type EffectiveStatus = "active" | "revoked" | "expired" | "idle_timeout";
+/**
+ * Creates a new key record and emits a creation audit event.
+ */
+export declare const create: import("convex/server").RegisteredMutation<"public", {
+    expiresAt?: number | undefined;
+    logLevel?: "debug" | "warn" | "error" | "none" | undefined;
+    maxIdleMs?: number | undefined;
+    metadata?: Record<string, any> | undefined;
+    name?: string | undefined;
+    namespace?: string | undefined;
+    permissions?: Record<string, string[]> | undefined;
+    tokenHash: string;
+    tokenLast4: string;
+    tokenPrefix: string;
+}, Promise<{
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    createdAt: number;
+}>>;
+/**
+ * Validates a token hash and returns the matching active key.
+ */
+export declare const validate: import("convex/server").RegisteredQuery<"public", {
+    logLevel?: "debug" | "warn" | "error" | "none" | undefined;
+    tokenHash: string;
+    now: number;
+}, Promise<{
+    ok: false;
+    reason: "not_found";
+    keyId?: undefined;
+    namespace?: undefined;
+    name?: undefined;
+    permissions?: undefined;
+    metadata?: undefined;
+} | {
+    ok: false;
+    reason: "revoked" | "expired" | "idle_timeout";
+    keyId?: undefined;
+    namespace?: undefined;
+    name?: undefined;
+    permissions?: undefined;
+    metadata?: undefined;
+} | {
+    ok: true;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    namespace: string | undefined;
+    name: string | undefined;
+    permissions: Record<string, string[]> | undefined;
+    metadata: Record<string, any> | undefined;
+    reason?: undefined;
+}>>;
+/**
+ * Marks a key as recently used and extends idle expiry when configured.
+ */
+export declare const touch: import("convex/server").RegisteredMutation<"public", {
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    now: number;
+}, Promise<{
+    ok: false;
+    reason: "not_found";
+    keyId?: undefined;
+    touchedAt?: undefined;
+} | {
+    ok: false;
+    reason: "revoked" | "expired" | "idle_timeout";
+    keyId?: undefined;
+    touchedAt?: undefined;
+} | {
+    ok: true;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    touchedAt: number;
+    reason?: undefined;
+}>>;
+/**
+ * Lists API keys with derived effective status.
+ */
+export declare const listKeys: import("convex/server").RegisteredQuery<"public", {
+    namespace?: string | undefined;
+    order?: "asc" | "desc" | undefined;
+    status?: "active" | "revoked" | undefined;
+    now: number;
+    paginationOpts: {
+        id?: number;
+        endCursor?: string | null;
+        maximumRowsRead?: number;
+        maximumBytesRead?: number;
+        numItems: number;
+        cursor: string | null;
+    };
+}, Promise<{
+    isDone: boolean;
+    continueCursor: string;
+    page: {
+        keyId: import("convex/values").GenericId<"apiKeys">;
+        namespace: string | undefined;
+        name: string | undefined;
+        tokenPrefix: string;
+        tokenLast4: string;
+        permissions: Record<string, string[]> | undefined;
+        metadata: Record<string, any> | undefined;
+        status: "active" | "revoked";
+        effectiveStatus: EffectiveStatus;
+        createdAt: number;
+        updatedAt: number;
+        lastUsedAt: number;
+        expiresAt: number | undefined;
+        maxIdleMs: number | undefined;
+        revokedAt: number | undefined;
+        revocationReason: string | undefined;
+        replaces: import("convex/values").GenericId<"apiKeys"> | undefined;
+    }[];
+}>>;
+/**
+ * Fetches a single API key by ID with its derived effective status.
+ */
+export declare const getKey: import("convex/server").RegisteredQuery<"public", {
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    now: number;
+}, Promise<{
+    ok: false;
+    reason: "not_found";
+    keyId?: undefined;
+    namespace?: undefined;
+    name?: undefined;
+    tokenPrefix?: undefined;
+    tokenLast4?: undefined;
+    permissions?: undefined;
+    metadata?: undefined;
+    status?: undefined;
+    effectiveStatus?: undefined;
+    createdAt?: undefined;
+    updatedAt?: undefined;
+    lastUsedAt?: undefined;
+    expiresAt?: undefined;
+    maxIdleMs?: undefined;
+    revokedAt?: undefined;
+    revocationReason?: undefined;
+    replaces?: undefined;
+} | {
+    ok: true;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    namespace: string | undefined;
+    name: string | undefined;
+    tokenPrefix: string;
+    tokenLast4: string;
+    permissions: Record<string, string[]> | undefined;
+    metadata: Record<string, any> | undefined;
+    status: "active" | "revoked";
+    effectiveStatus: EffectiveStatus;
+    createdAt: number;
+    updatedAt: number;
+    lastUsedAt: number;
+    expiresAt: number | undefined;
+    maxIdleMs: number | undefined;
+    revokedAt: number | undefined;
+    revocationReason: string | undefined;
+    replaces: import("convex/values").GenericId<"apiKeys"> | undefined;
+    reason?: undefined;
+}>>;
+/**
+ * Lists audit events for a single key.
+ */
+export declare const listKeyEvents: import("convex/server").RegisteredQuery<"public", {
+    order?: "asc" | "desc" | undefined;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    paginationOpts: {
+        id?: number;
+        endCursor?: string | null;
+        maximumRowsRead?: number;
+        maximumBytesRead?: number;
+        numItems: number;
+        cursor: string | null;
+    };
+}, Promise<{
+    isDone: boolean;
+    continueCursor: string;
+    page: {
+        eventId: import("convex/values").GenericId<"apiKeyEvents">;
+        keyId: import("convex/values").GenericId<"apiKeys">;
+        namespace: string | undefined;
+        type: "revoked" | "created" | "rotated";
+        reason: string | undefined;
+        metadata: Record<string, any> | undefined;
+        createdAt: number;
+    }[];
+}>>;
+/**
+ * Lists audit events across all keys, optionally scoped by namespace.
+ */
+export declare const listEvents: import("convex/server").RegisteredQuery<"public", {
+    namespace?: string | undefined;
+    order?: "asc" | "desc" | undefined;
+    paginationOpts: {
+        id?: number;
+        endCursor?: string | null;
+        maximumRowsRead?: number;
+        maximumBytesRead?: number;
+        numItems: number;
+        cursor: string | null;
+    };
+}, Promise<{
+    isDone: boolean;
+    continueCursor: string;
+    page: {
+        eventId: import("convex/values").GenericId<"apiKeyEvents">;
+        keyId: import("convex/values").GenericId<"apiKeys">;
+        namespace: string | undefined;
+        type: "revoked" | "created" | "rotated";
+        reason: string | undefined;
+        metadata: Record<string, any> | undefined;
+        createdAt: number;
+    }[];
+}>>;
+/**
+ * Revokes a single key and records the revocation event.
+ */
+export declare const invalidate: import("convex/server").RegisteredMutation<"public", {
+    logLevel?: "debug" | "warn" | "error" | "none" | undefined;
+    metadata?: Record<string, any> | undefined;
+    reason?: string | undefined;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    now: number;
+}, Promise<{
+    ok: false;
+    reason: "not_found";
+    keyId?: undefined;
+    revokedAt?: undefined;
+} | {
+    ok: false;
+    reason: "revoked";
+    keyId?: undefined;
+    revokedAt?: undefined;
+} | {
+    ok: true;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    revokedAt: number;
+    reason?: undefined;
+}>>;
+/**
+ * Revokes active keys in pages using optional namespace/time filters.
+ */
+export declare const invalidateAll: import("convex/server").RegisteredMutation<"public", {
+    logLevel?: "debug" | "warn" | "error" | "none" | undefined;
+    metadata?: Record<string, any> | undefined;
+    namespace?: string | undefined;
+    reason?: string | undefined;
+    after?: number | undefined;
+    before?: number | undefined;
+    now: number;
+    paginationOpts: {
+        id?: number;
+        endCursor?: string | null;
+        maximumRowsRead?: number;
+        maximumBytesRead?: number;
+        numItems: number;
+        cursor: string | null;
+    };
+}, Promise<{
+    processed: number;
+    revoked: number;
+    isDone: boolean;
+    continueCursor: string;
+}>>;
+/**
+ * Updates mutable key properties (name, metadata, expiry).
+ * Passing `expiresAt: null` removes the expiry field entirely.
+ */
+export declare const update: import("convex/server").RegisteredMutation<"public", {
+    expiresAt?: number | null | undefined;
+    logLevel?: "debug" | "warn" | "error" | "none" | undefined;
+    maxIdleMs?: number | null | undefined;
+    metadata?: Record<string, any> | undefined;
+    name?: string | undefined;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+}, Promise<{
+    ok: false;
+    reason: "not_found";
+    keyId?: undefined;
+} | {
+    ok: false;
+    reason: "already_revoked";
+    keyId?: undefined;
+} | {
+    ok: true;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    reason?: undefined;
+}>>;
+/**
+ * Rotates a key by revoking the old key and creating a replacement.
+ */
+export declare const refresh: import("convex/server").RegisteredMutation<"public", {
+    logLevel?: "debug" | "warn" | "error" | "none" | undefined;
+    metadata?: Record<string, any> | undefined;
+    reason?: string | undefined;
+    tokenHash: string;
+    tokenLast4: string;
+    tokenPrefix: string;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    now: number;
+}, Promise<{
+    ok: false;
+    reason: "not_found";
+    keyId?: undefined;
+    replacedKeyId?: undefined;
+    createdAt?: undefined;
+    expiresAt?: undefined;
+} | {
+    ok: false;
+    reason: "revoked" | "expired" | "idle_timeout";
+    keyId?: undefined;
+    replacedKeyId?: undefined;
+    createdAt?: undefined;
+    expiresAt?: undefined;
+} | {
+    ok: true;
+    keyId: import("convex/values").GenericId<"apiKeys">;
+    replacedKeyId: import("convex/values").GenericId<"apiKeys">;
+    createdAt: number;
+    expiresAt: number | undefined;
+    reason?: undefined;
+}>>;
+export {};
+//# sourceMappingURL=lib.d.ts.map

package/dist/component/lib.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/component/lib.ts"],"names":[],"mappings":"AAkCA,KAAK,eAAe,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,cAAc,CAAC;AAiNzE;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;GAyEjB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCnB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;GA4BhB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDnB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCjB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;GAoBxB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;GAwBrB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;GAyCrB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;GAsExB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;GA+EjB,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmFlB,CAAC"}