shred-api-client 1.14.3 → 1.14.4-rc.2

package/dist/model/goal/Goal.schema.d.ts

@@ -0,0 +1,154 @@
+import { z } from "zod";
+export declare const DailyMilestoneSchema: z.ZodObject<{
+    id: z.ZodString;
+    date: z.ZodString;
+    target: z.ZodNumber;
+    progress: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    date: string;
+    progress: number;
+    target: number;
+}, {
+    id: string;
+    date: string;
+    progress: number;
+    target: number;
+}>;
+export declare const WeeklyMilestoneSchema: z.ZodObject<{
+    id: z.ZodString;
+    week: z.ZodString;
+    target: z.ZodNumber;
+    progress: z.ZodNumber;
+    dailyMilestones: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        date: z.ZodString;
+        target: z.ZodNumber;
+        progress: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        date: string;
+        progress: number;
+        target: number;
+    }, {
+        id: string;
+        date: string;
+        progress: number;
+        target: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    progress: number;
+    target: number;
+    week: string;
+    dailyMilestones: {
+        id: string;
+        date: string;
+        progress: number;
+        target: number;
+    }[];
+}, {
+    id: string;
+    progress: number;
+    target: number;
+    week: string;
+    dailyMilestones: {
+        id: string;
+        date: string;
+        progress: number;
+        target: number;
+    }[];
+}>;
+export declare const GoalSchema: z.ZodObject<{
+    id: z.ZodString;
+    editorId: z.ZodString;
+    month: z.ZodString;
+    target: z.ZodNumber;
+    progress: z.ZodNumber;
+    createdAt: z.ZodNumber;
+    weeklyMilestones: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        week: z.ZodString;
+        target: z.ZodNumber;
+        progress: z.ZodNumber;
+        dailyMilestones: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            date: z.ZodString;
+            target: z.ZodNumber;
+            progress: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            date: string;
+            progress: number;
+            target: number;
+        }, {
+            id: string;
+            date: string;
+            progress: number;
+            target: number;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        progress: number;
+        target: number;
+        week: string;
+        dailyMilestones: {
+            id: string;
+            date: string;
+            progress: number;
+            target: number;
+        }[];
+    }, {
+        id: string;
+        progress: number;
+        target: number;
+        week: string;
+        dailyMilestones: {
+            id: string;
+            date: string;
+            progress: number;
+            target: number;
+        }[];
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    createdAt: number;
+    editorId: string;
+    progress: number;
+    target: number;
+    month: string;
+    weeklyMilestones: {
+        id: string;
+        progress: number;
+        target: number;
+        week: string;
+        dailyMilestones: {
+            id: string;
+            date: string;
+            progress: number;
+            target: number;
+        }[];
+    }[];
+}, {
+    id: string;
+    createdAt: number;
+    editorId: string;
+    progress: number;
+    target: number;
+    month: string;
+    weeklyMilestones: {
+        id: string;
+        progress: number;
+        target: number;
+        week: string;
+        dailyMilestones: {
+            id: string;
+            date: string;
+            progress: number;
+            target: number;
+        }[];
+    }[];
+}>;
+export type DailyMilestone = z.infer<typeof DailyMilestoneSchema>;
+export type WeeklyMilestone = z.infer<typeof WeeklyMilestoneSchema>;
+export type Goal = z.infer<typeof GoalSchema>;

package/dist/model/goal/Goal.schema.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoalSchema = exports.WeeklyMilestoneSchema = exports.DailyMilestoneSchema = void 0;
+const zod_1 = require("zod");
+exports.DailyMilestoneSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    date: zod_1.z.string(),
+    target: zod_1.z.number(),
+    progress: zod_1.z.number(),
+});
+exports.WeeklyMilestoneSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    week: zod_1.z.string(),
+    target: zod_1.z.number(),
+    progress: zod_1.z.number(),
+    dailyMilestones: zod_1.z.array(exports.DailyMilestoneSchema),
+});
+exports.GoalSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    editorId: zod_1.z.string(),
+    month: zod_1.z.string(), // ex: "2024-04"
+    target: zod_1.z.number(),
+    progress: zod_1.z.number(),
+    createdAt: zod_1.z.number(),
+    weeklyMilestones: zod_1.z.array(exports.WeeklyMilestoneSchema),
+});

package/dist/model/goal/index.d.ts

@@ -0,0 +1,3 @@
+export type { Goal as Entity, DailyMilestone, WeeklyMilestone, } from "./Goal.schema";
+export { GoalSchema, DailyMilestoneSchema, WeeklyMilestoneSchema, } from "./Goal.schema";
+export * from "./Goal.api";

package/dist/model/goal/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WeeklyMilestoneSchema = exports.DailyMilestoneSchema = exports.GoalSchema = void 0;
+var Goal_schema_1 = require("./Goal.schema");
+Object.defineProperty(exports, "GoalSchema", { enumerable: true, get: function () { return Goal_schema_1.GoalSchema; } });
+Object.defineProperty(exports, "DailyMilestoneSchema", { enumerable: true, get: function () { return Goal_schema_1.DailyMilestoneSchema; } });
+Object.defineProperty(exports, "WeeklyMilestoneSchema", { enumerable: true, get: function () { return Goal_schema_1.WeeklyMilestoneSchema; } });
+__exportStar(require("./Goal.api"), exports);

package/dist/model/note/Note.api.d.ts

@@ -0,0 +1,26 @@
+import Context from "../Context";
+import { Note } from "./Note.schema";
+export interface IAPI {
+    list: (c: Context, userId: string) => Promise<Note[]>;
+    add: (c: Context, note: Note) => Promise<Note>;
+    update: (c: Context, script: Partial<Note>) => Promise<Note>;
+    delete: (c: Context, id: string) => Promise<boolean>;
+}
+export declare const Endpoints: {
+    GetNotes: {
+        uri: string;
+        method: string;
+    };
+    AddNote: {
+        uri: string;
+        method: string;
+    };
+    DeleteNote: {
+        uri: string;
+        method: string;
+    };
+    UpdateNote: {
+        uri: string;
+        method: string;
+    };
+};

package/dist/model/note/Note.api.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoints = void 0;
+exports.Endpoints = {
+    GetNotes: {
+        uri: "/user-context/notes/:userId/",
+        method: "GET",
+    },
+    AddNote: {
+        uri: "/user-context/notes/",
+        method: "PUT",
+    },
+    DeleteNote: {
+        uri: "/user-context/notes/:id/",
+        method: "DELETE",
+    },
+    UpdateNote: {
+        uri: "/user-context/notes/:id/",
+        method: "POST",
+    },
+};

package/dist/model/note/Note.schema.d.ts

@@ -0,0 +1,141 @@
+import { z } from "zod";
+declare const NoteHistorySchema: z.ZodObject<{
+    type: z.ZodEnum<["created", "updated", "deleted", "asset-added", "asset-removed"]>;
+    actorEmail: z.ZodString;
+    timestamp: z.ZodNumber;
+    details: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "deleted" | "created" | "updated" | "asset-added" | "asset-removed";
+    timestamp: number;
+    actorEmail: string;
+    details?: string | undefined;
+}, {
+    type: "deleted" | "created" | "updated" | "asset-added" | "asset-removed";
+    timestamp: number;
+    actorEmail: string;
+    details?: string | undefined;
+}>;
+declare const NoteSchema: z.ZodObject<{
+    id: z.ZodString;
+    userId: z.ZodString;
+    authorEmail: z.ZodString;
+    assets: z.ZodArray<z.ZodObject<{
+        assetId: z.ZodString;
+        fileName: z.ZodString;
+        extension: z.ZodString;
+        fileSize: z.ZodNumber;
+        assetUrl: z.ZodString;
+        thumbnailUrl: z.ZodString;
+        type: z.ZodString;
+        duration: z.ZodOptional<z.ZodNumber>;
+        progress: z.ZodOptional<z.ZodNumber>;
+        error: z.ZodOptional<z.ZodString>;
+        authorId: z.ZodString;
+        uploadedAt: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        authorId: string;
+        uploadedAt: number;
+        error?: string | undefined;
+        duration?: number | undefined;
+        progress?: number | undefined;
+    }, {
+        type: string;
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        authorId: string;
+        uploadedAt: number;
+        error?: string | undefined;
+        duration?: number | undefined;
+        progress?: number | undefined;
+    }>, "many">;
+    title: z.ZodString;
+    content: z.ZodString;
+    createdAt: z.ZodNumber;
+    modified: z.ZodNumber;
+    history: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<["created", "updated", "deleted", "asset-added", "asset-removed"]>;
+        actorEmail: z.ZodString;
+        timestamp: z.ZodNumber;
+        details: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "deleted" | "created" | "updated" | "asset-added" | "asset-removed";
+        timestamp: number;
+        actorEmail: string;
+        details?: string | undefined;
+    }, {
+        type: "deleted" | "created" | "updated" | "asset-added" | "asset-removed";
+        timestamp: number;
+        actorEmail: string;
+        details?: string | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    userId: string;
+    title: string;
+    createdAt: number;
+    modified: number;
+    content: string;
+    assets: {
+        type: string;
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        authorId: string;
+        uploadedAt: number;
+        error?: string | undefined;
+        duration?: number | undefined;
+        progress?: number | undefined;
+    }[];
+    authorEmail: string;
+    history?: {
+        type: "deleted" | "created" | "updated" | "asset-added" | "asset-removed";
+        timestamp: number;
+        actorEmail: string;
+        details?: string | undefined;
+    }[] | undefined;
+}, {
+    id: string;
+    userId: string;
+    title: string;
+    createdAt: number;
+    modified: number;
+    content: string;
+    assets: {
+        type: string;
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        authorId: string;
+        uploadedAt: number;
+        error?: string | undefined;
+        duration?: number | undefined;
+        progress?: number | undefined;
+    }[];
+    authorEmail: string;
+    history?: {
+        type: "deleted" | "created" | "updated" | "asset-added" | "asset-removed";
+        timestamp: number;
+        actorEmail: string;
+        details?: string | undefined;
+    }[] | undefined;
+}>;
+type Note = z.infer<typeof NoteSchema>;
+type NoteHistory = z.infer<typeof NoteHistorySchema>;
+export { NoteHistorySchema, NoteSchema, NoteHistory, Note };

package/dist/model/note/Note.schema.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteSchema = exports.NoteHistorySchema = void 0;
+const zod_1 = require("zod");
+const asset_1 = require("../asset");
+const NoteHistorySchema = zod_1.z.object({
+    type: zod_1.z.enum([
+        "created",
+        "updated",
+        "deleted",
+        "asset-added",
+        "asset-removed",
+    ]),
+    actorEmail: zod_1.z.string().email(),
+    timestamp: zod_1.z.number(),
+    details: zod_1.z.string().optional(),
+});
+exports.NoteHistorySchema = NoteHistorySchema;
+const NoteSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    userId: zod_1.z.string(),
+    authorEmail: zod_1.z.string().email(),
+    assets: zod_1.z.array(asset_1.AssetSchema),
+    title: zod_1.z.string(),
+    content: zod_1.z.string(),
+    createdAt: zod_1.z.number(),
+    modified: zod_1.z.number(),
+    history: zod_1.z.array(NoteHistorySchema).optional(),
+});
+exports.NoteSchema = NoteSchema;

package/dist/model/note/index.d.ts

@@ -0,0 +1,2 @@
+export { NoteSchema, NoteHistorySchema } from "./Note.schema";
+export type { Note as Entity, NoteHistory } from "./Note.schema";

package/dist/model/note/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoteHistorySchema = exports.NoteSchema = void 0;
+var Note_schema_1 = require("./Note.schema");
+Object.defineProperty(exports, "NoteSchema", { enumerable: true, get: function () { return Note_schema_1.NoteSchema; } });
+Object.defineProperty(exports, "NoteHistorySchema", { enumerable: true, get: function () { return Note_schema_1.NoteHistorySchema; } });

package/dist/model/notification/Notification.api.d.ts

@@ -0,0 +1,47 @@
+import Context from "../Context";
+import { Trigger, NotificationDetail, NotificationItem } from "./Notification.schema";
+import * as Core from "../core/";
+export interface IAPI {
+    getTriggers: (ctx: Context) => Promise<Core.APIResponse<Trigger>>;
+    createTrigger: (ctx: Context, t: Trigger) => Promise<Trigger>;
+    deleteTrigger: (ctx: Context, triggerId: string) => Promise<boolean>;
+    updateTrigger: (ctx: Context, triggerId: string, trigger: Partial<Trigger>) => Promise<Trigger>;
+    push: (context: Context, notification: NotificationDetail) => Promise<boolean>;
+    getNotifications: (ctx: Context) => Promise<Core.APIResponse<NotificationItem>>;
+    markAsRead: (ctx: Context, id: string) => Promise<boolean>;
+    clearNotifications: (ctx: Context) => Promise<boolean>;
+}
+export declare const Endpoints: {
+    Create: {
+        uri: string;
+        method: string;
+    };
+    List: {
+        uri: string;
+        method: string;
+    };
+    Update: {
+        uri: string;
+        method: string;
+    };
+    Delete: {
+        uri: string;
+        method: string;
+    };
+    Push: {
+        uri: string;
+        method: string;
+    };
+    ListNotifications: {
+        uri: string;
+        method: string;
+    };
+    MarkAsRead: {
+        uri: string;
+        method: string;
+    };
+    ClearNotifications: {
+        uri: string;
+        method: string;
+    };
+};

package/dist/model/notification/Notification.api.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoints = void 0;
+exports.Endpoints = {
+    Create: { uri: "/notifications/trigger/", method: "POST" },
+    List: { uri: "/notifications/trigger/list/", method: "GET" },
+    Update: { uri: "/notifications/trigger/:id/", method: "PUT" },
+    Delete: { uri: "/notifications/trigger/:id/", method: "DELETE" },
+    Push: { uri: "/notifications/push/", method: "POST" },
+    ListNotifications: { uri: "/notifications/list/", method: "GET" },
+    MarkAsRead: { uri: "/notifications/:id/read/", method: "PUT" },
+    ClearNotifications: { uri: "/notifications/clear/", method: "DELETE" },
+};