shred-api-client 1.14.1 → 1.14.3

package/dist/api/Project.api.d.ts

@@ -1,10 +1,11 @@
 import Environment from "../model/Env";
-import { Approve, Project, ProjectAPISchema, ProjectCreation, Query, SendToApproval } from "../model/Project.schema";
+import { Approve, Goal, Project, ProjectAPISchema, ProjectCreation, Query, SendToApproval } from "../model/Project.schema";
 import Context from "../model/Context";
 declare class ProjectAPI implements ProjectAPISchema {
     private env;
     private clientHTTP;
     constructor(env: Environment);
+    getGoals(context: Context): Promise<Goal[]>;
     find(context: Context, projectId: string): Promise<Project>;
     create(context: Context, createData: ProjectCreation): Promise<Project>;
     review(ctx: Context, pId: string, revision: string): Promise<boolean>;

package/dist/api/Project.api.js

@@ -10,6 +10,11 @@ class ProjectAPI {
         this.env = env;
         this.clientHTTP = new HTTPClient_1.default();
     }
+    async getGoals(context) {
+        const endpointData = Project_schema_1.ProjectEndpoints.GetGoals;
+        const data = await this.clientHTTP.makeRequest(this.env, endpointData.uri, endpointData.method, null, context);
+        return data;
+    }
     async find(context, projectId) {
         const endpointData = Project_schema_1.ProjectEndpoints.FindOne;
         const endpoint = endpointData.uri.replace(":projectId", projectId);

package/dist/model/Api.d.ts

@@ -8,11 +8,26 @@ import { TenantAPISchema } from "./Tenant.schema";
 import { ProjectAPISchema } from "./Project.schema";
 import { APPConfigSchema } from "./AppConfig.schema";
 import { TrackAPISchema } from "./Track.schema";
+export type QueryOrderBy<T> = {
+    field: keyof T | "modified";
+    direction: "asc" | "desc";
+};
+export type QueryWhere<T> = {
+    field: keyof T | "modified";
+    operation: "==" | "!=" | ">" | "<" | ">=" | "<=" | "in" | "array-contains";
+    value: T[keyof T] | T[keyof T][];
+};
+export type QueryOptions<T> = {
+    perPage?: number;
+    cursor?: string | number | null;
+    orderBy?: QueryOrderBy<T>;
+    wheres?: QueryWhere<T>[];
+};
 export type APIResponse<T> = {
-    perPage: number;
-    last?: T;
     data: T[];
     count: number;
+    cursor?: string | number | null;
+    perPage?: number;
 };
 export declare class ShredAPI {
     user: UserAPISchema;

package/dist/model/Asset.schema.d.ts

@@ -1,13 +1,43 @@
-type Asset = {
-    duration?: number;
+import { z } from "zod";
+declare const AssetSchema: 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, {
+    assetId: string;
     fileName: string;
     extension: string;
     fileSize: number;
-    thumbnailUrl: string;
     assetUrl: string;
+    thumbnailUrl: string;
     type: string;
+    authorId: string;
+    uploadedAt: number;
+    duration?: number | undefined;
+    progress?: number | undefined;
+    error?: string | undefined;
+}, {
     assetId: string;
-    progress?: number;
-    error?: string;
-};
-export { Asset };
+    fileName: string;
+    extension: string;
+    fileSize: number;
+    assetUrl: string;
+    thumbnailUrl: string;
+    type: string;
+    authorId: string;
+    uploadedAt: number;
+    duration?: number | undefined;
+    progress?: number | undefined;
+    error?: string | undefined;
+}>;
+type Asset = z.infer<typeof AssetSchema>;
+export { Asset, AssetSchema };

package/dist/model/Asset.schema.js

@@ -1,2 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetSchema = void 0;
+const zod_1 = require("zod");
+const AssetSchema = zod_1.z.object({
+    assetId: zod_1.z.string(),
+    fileName: zod_1.z.string(),
+    extension: zod_1.z.string(),
+    fileSize: zod_1.z.number(),
+    assetUrl: zod_1.z.string().url(),
+    thumbnailUrl: zod_1.z.string().url(),
+    type: zod_1.z.string(),
+    duration: zod_1.z.number().optional(),
+    progress: zod_1.z.number().optional(),
+    error: zod_1.z.string().optional(),
+    authorId: zod_1.z.string(),
+    uploadedAt: zod_1.z.number(),
+});
+exports.AssetSchema = AssetSchema;

package/dist/model/Project.schema.d.ts

@@ -27,6 +27,7 @@ interface ProjectAPISchema {
     deny: (context: Context, projectId: string, denyFeedback: string, categories?: string[]) => Promise<boolean>;
     unschedule: (context: Context, projectId: string) => Promise<boolean>;
     rollback: (context: Context, projectId: string) => Promise<boolean>;
+    getGoals: (context: Context) => Promise<Goal[]>;
 }
 declare const ProjectEndpoints: {
     List: {
@@ -41,6 +42,10 @@ declare const ProjectEndpoints: {
         uri: string;
         method: string;
     };
+    GetGoals: {
+        uri: string;
+        method: string;
+    };
     Review: {
         uri: string;
         method: string;
@@ -122,4 +127,26 @@ type Project = {
     tenantId?: string;
     status: Status;
 };
-export { Project, ProjectAPISchema, ProjectEndpoints, TimelineItem };
+type DailyMilestone = {
+    id: string;
+    date: string;
+    target: number;
+    progress: number;
+};
+type WeeklyMilestone = {
+    id: string;
+    week: string;
+    target: number;
+    progress: number;
+    dailyMilestones: DailyMilestone[];
+};
+type Goal = {
+    id: string;
+    editorId: string;
+    month: string;
+    target: number;
+    progress: number;
+    createdAt: number;
+    weeklyMilestones: WeeklyMilestone[];
+};
+export { Project, DailyMilestone, WeeklyMilestone, Goal, ProjectAPISchema, ProjectEndpoints, TimelineItem, };

package/dist/model/Project.schema.js

@@ -14,6 +14,10 @@ const ProjectEndpoints = {
         uri: `/projects/:projectId/`,
         method: "GET",
     },
+    GetGoals: {
+        uri: `/projects/goals/list/`,
+        method: "GET",
+    },
     Review: {
         uri: "/projects/:projectId/review/",
         method: "POST",

package/dist/model/User.schema.d.ts

@@ -1,4 +1,5 @@
 import Context from "./Context";
+import { z } from "zod";
 export type Update = Pick<User, "name" | "profession" | "preferences" | "photoUrl" | "fcmToken" | "timezone" | "experienceId">;
 interface UserAPISchema {
     getUserInfo: (context: Context) => Promise<User>;
@@ -114,4 +115,139 @@ type User = {
     customerId: string;
     role: Role;
 };
+export declare const NoteSchema: z.ZodObject<{
+    id: z.ZodString;
+    authorEmail: z.ZodString;
+    content: z.ZodString;
+    createdAt: z.ZodNumber;
+    modified: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    authorEmail: string;
+    content: string;
+    createdAt: number;
+    modified: number;
+}, {
+    id: string;
+    authorEmail: string;
+    content: string;
+    createdAt: number;
+    modified: number;
+}>;
+export declare const UserNoteSchema: z.ZodObject<{
+    userId: z.ZodString;
+    notes: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        authorEmail: z.ZodString;
+        content: z.ZodString;
+        createdAt: z.ZodNumber;
+        modified: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        authorEmail: string;
+        content: string;
+        createdAt: number;
+        modified: number;
+    }, {
+        id: string;
+        authorEmail: string;
+        content: string;
+        createdAt: number;
+        modified: number;
+    }>, "many">;
+    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, {
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        type: string;
+        authorId: string;
+        uploadedAt: number;
+        duration?: number | undefined;
+        progress?: number | undefined;
+        error?: string | undefined;
+    }, {
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        type: string;
+        authorId: string;
+        uploadedAt: number;
+        duration?: number | undefined;
+        progress?: number | undefined;
+        error?: string | undefined;
+    }>, "many">;
+    createdAt: z.ZodNumber;
+    modified: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    createdAt: number;
+    modified: number;
+    userId: string;
+    notes: {
+        id: string;
+        authorEmail: string;
+        content: string;
+        createdAt: number;
+        modified: number;
+    }[];
+    assets: {
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        type: string;
+        authorId: string;
+        uploadedAt: number;
+        duration?: number | undefined;
+        progress?: number | undefined;
+        error?: string | undefined;
+    }[];
+}, {
+    createdAt: number;
+    modified: number;
+    userId: string;
+    notes: {
+        id: string;
+        authorEmail: string;
+        content: string;
+        createdAt: number;
+        modified: number;
+    }[];
+    assets: {
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        type: string;
+        authorId: string;
+        uploadedAt: number;
+        duration?: number | undefined;
+        progress?: number | undefined;
+        error?: string | undefined;
+    }[];
+}>;
+export type Note = z.infer<typeof NoteSchema>;
+export type UserNote = z.infer<typeof UserNoteSchema>;
 export { User, Preferences, UserAPISchema, UserEndpoints, Role, System };

package/dist/model/User.schema.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.System = exports.Role = exports.UserEndpoints = void 0;
+exports.System = exports.Role = exports.UserEndpoints = exports.UserNoteSchema = exports.NoteSchema = void 0;
+const Asset_schema_1 = require("./Asset.schema");
+const zod_1 = require("zod");
 const UserEndpoints = {
     ChangeEmail: {
         uri: "/accounts/user/changeEmail",
@@ -79,3 +81,17 @@ var System;
     System["QA"] = "QA";
     System["ADMIN"] = "ADMIN";
 })(System || (exports.System = System = {}));
+exports.NoteSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    authorEmail: zod_1.z.string().email(),
+    content: zod_1.z.string(),
+    createdAt: zod_1.z.number(),
+    modified: zod_1.z.number(),
+});
+exports.UserNoteSchema = zod_1.z.object({
+    userId: zod_1.z.string(),
+    notes: zod_1.z.array(exports.NoteSchema),
+    assets: zod_1.z.array(Asset_schema_1.AssetSchema),
+    createdAt: zod_1.z.number(),
+    modified: zod_1.z.number(),
+});

package/dist/namespace.d.ts

@@ -1,10 +1,10 @@
 import { Product as TProduct, Subscription as TSubscription, Charge as TCharge } from "./model/Subscription.schema";
 import { Trigger as TTrigger, Criteria as TCriteria, NotificationDetail as TNContent, RecurrenceRule as TRRule, NotificationItem as TNotificaitonItem, History as THistory } from "./model/Notification.schema";
 import { APIResponse } from "./model/Api";
-import { System as TSystem, User as TUser, Preferences as UserPreferences, Role as TRole } from "./model/User.schema";
+import { System as TSystem, User as TUser, Preferences as UserPreferences, Role as TRole, UserNote as TUserNote } from "./model/User.schema";
 import { Email as TEmail } from "./model/Email.schema";
 import { Asset as TAsset } from "./model/Asset.schema";
-import { Project as TProject, TimelineItem as TTimlineItem } from "./model/Project.schema";
+import { Project as TProject, TimelineItem as TTimlineItem, WeeklyMilestone as TWeeklyMilestone, DailyMilestone as TDailyMilestone, Goal as TGoal } from "./model/Project.schema";
 import { Tenant as TTenant } from "./model/Tenant.schema";
 import { Track as TTrack } from "./model/Track.schema";
 import { Prompt as TPrompt, Script as TScript, Category as TCategory } from "./model/Prompt.schema";
@@ -30,6 +30,12 @@ export declare namespace Shred {
         type Category = TCategory;
     }
 }
+export declare namespace Schemas { }
+export declare namespace Goal {
+    type WeeklyMilestone = TWeeklyMilestone;
+    type DailyMilestone = TDailyMilestone;
+    type Month = TGoal;
+}
 export declare namespace Notification {
     enum Frequency {
         DAILY = "daily",
@@ -74,4 +80,180 @@ export declare namespace Notification {
 }
 export declare namespace User {
     type Preferences = UserPreferences;
+    type Note = TUserNote;
 }
+export declare const Schemas: {
+    Asset: import("zod").ZodObject<{
+        assetId: import("zod").ZodString;
+        fileName: import("zod").ZodString;
+        extension: import("zod").ZodString;
+        fileSize: import("zod").ZodNumber;
+        assetUrl: import("zod").ZodString;
+        thumbnailUrl: import("zod").ZodString;
+        type: import("zod").ZodString;
+        duration: import("zod").ZodOptional<import("zod").ZodNumber>;
+        progress: import("zod").ZodOptional<import("zod").ZodNumber>;
+        error: import("zod").ZodOptional<import("zod").ZodString>;
+        authorId: import("zod").ZodString;
+        uploadedAt: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        type: string;
+        authorId: string;
+        uploadedAt: number;
+        duration?: number | undefined;
+        progress?: number | undefined;
+        error?: string | undefined;
+    }, {
+        assetId: string;
+        fileName: string;
+        extension: string;
+        fileSize: number;
+        assetUrl: string;
+        thumbnailUrl: string;
+        type: string;
+        authorId: string;
+        uploadedAt: number;
+        duration?: number | undefined;
+        progress?: number | undefined;
+        error?: string | undefined;
+    }>;
+    Note: import("zod").ZodObject<{
+        id: import("zod").ZodString;
+        authorEmail: import("zod").ZodString;
+        content: import("zod").ZodString;
+        createdAt: import("zod").ZodNumber;
+        modified: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        authorEmail: string;
+        content: string;
+        createdAt: number;
+        modified: number;
+    }, {
+        id: string;
+        authorEmail: string;
+        content: string;
+        createdAt: number;
+        modified: number;
+    }>;
+    UserNote: import("zod").ZodObject<{
+        userId: import("zod").ZodString;
+        notes: import("zod").ZodArray<import("zod").ZodObject<{
+            id: import("zod").ZodString;
+            authorEmail: import("zod").ZodString;
+            content: import("zod").ZodString;
+            createdAt: import("zod").ZodNumber;
+            modified: import("zod").ZodNumber;
+        }, "strip", import("zod").ZodTypeAny, {
+            id: string;
+            authorEmail: string;
+            content: string;
+            createdAt: number;
+            modified: number;
+        }, {
+            id: string;
+            authorEmail: string;
+            content: string;
+            createdAt: number;
+            modified: number;
+        }>, "many">;
+        assets: import("zod").ZodArray<import("zod").ZodObject<{
+            assetId: import("zod").ZodString;
+            fileName: import("zod").ZodString;
+            extension: import("zod").ZodString;
+            fileSize: import("zod").ZodNumber;
+            assetUrl: import("zod").ZodString;
+            thumbnailUrl: import("zod").ZodString;
+            type: import("zod").ZodString;
+            duration: import("zod").ZodOptional<import("zod").ZodNumber>;
+            progress: import("zod").ZodOptional<import("zod").ZodNumber>;
+            error: import("zod").ZodOptional<import("zod").ZodString>;
+            authorId: import("zod").ZodString;
+            uploadedAt: import("zod").ZodNumber;
+        }, "strip", import("zod").ZodTypeAny, {
+            assetId: string;
+            fileName: string;
+            extension: string;
+            fileSize: number;
+            assetUrl: string;
+            thumbnailUrl: string;
+            type: string;
+            authorId: string;
+            uploadedAt: number;
+            duration?: number | undefined;
+            progress?: number | undefined;
+            error?: string | undefined;
+        }, {
+            assetId: string;
+            fileName: string;
+            extension: string;
+            fileSize: number;
+            assetUrl: string;
+            thumbnailUrl: string;
+            type: string;
+            authorId: string;
+            uploadedAt: number;
+            duration?: number | undefined;
+            progress?: number | undefined;
+            error?: string | undefined;
+        }>, "many">;
+        createdAt: import("zod").ZodNumber;
+        modified: import("zod").ZodNumber;
+    }, "strip", import("zod").ZodTypeAny, {
+        createdAt: number;
+        modified: number;
+        userId: string;
+        notes: {
+            id: string;
+            authorEmail: string;
+            content: string;
+            createdAt: number;
+            modified: number;
+        }[];
+        assets: {
+            assetId: string;
+            fileName: string;
+            extension: string;
+            fileSize: number;
+            assetUrl: string;
+            thumbnailUrl: string;
+            type: string;
+            authorId: string;
+            uploadedAt: number;
+            duration?: number | undefined;
+            progress?: number | undefined;
+            error?: string | undefined;
+        }[];
+    }, {
+        createdAt: number;
+        modified: number;
+        userId: string;
+        notes: {
+            id: string;
+            authorEmail: string;
+            content: string;
+            createdAt: number;
+            modified: number;
+        }[];
+        assets: {
+            assetId: string;
+            fileName: string;
+            extension: string;
+            fileSize: number;
+            assetUrl: string;
+            thumbnailUrl: string;
+            type: string;
+            authorId: string;
+            uploadedAt: number;
+            duration?: number | undefined;
+            progress?: number | undefined;
+            error?: string | undefined;
+        }[];
+    }>;
+};

package/dist/namespace.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Notification = void 0;
+exports.Schemas = exports.Notification = void 0;
+const User_schema_1 = require("./model/User.schema");
+const Asset_schema_1 = require("./model/Asset.schema");
 var Notification;
 (function (Notification) {
     let Frequency;
@@ -43,3 +45,9 @@ var Notification;
         Status["EXPIRED"] = "expired";
     })(Status = Notification.Status || (Notification.Status = {}));
 })(Notification || (exports.Notification = Notification = {}));
+//Schemas
+exports.Schemas = {
+    Asset: Asset_schema_1.AssetSchema,
+    Note: User_schema_1.NoteSchema,
+    UserNote: User_schema_1.UserNoteSchema,
+};

package/dist/util/parseQuery.d.ts

@@ -0,0 +1,2 @@
+import { QueryOptions } from "../model/Api";
+export declare const buildQueryString: <T>(query: Partial<QueryOptions<T>>) => string;

package/dist/util/parseQuery.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildQueryString = void 0;
+const buildQueryString = (query) => {
+    const params = {};
+    if (query.perPage) {
+        params["perPage"] = [String(query.perPage)];
+    }
+    if (query.cursor !== undefined && query.cursor !== null) {
+        params["cursor"] = [String(query.cursor)];
+    }
+    if (query.orderBy) {
+        params["orderBy"] = [
+            `${String(query.orderBy.field)}:${query.orderBy.direction}`,
+        ];
+    }
+    if (query.wheres && query.wheres.length > 0) {
+        params["wheres"] = query.wheres.map((w) => `${String(w.field)}:${String(w.operation)}:${String(w.value)}`);
+    }
+    const queryString = Object.entries(params)
+        .flatMap(([key, values]) => values.map((value) => `${key}=${encodeURIComponent(value)}`))
+        .join("&");
+    return queryString ? `?${queryString}` : "";
+};
+exports.buildQueryString = buildQueryString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shred-api-client",
-  "version": "1.14.1",
+  "version": "1.14.3",
   "description": "API Client for Shred",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -17,11 +17,12 @@
   "dependencies": {
     "axios": "1.7.2",
     "uuid": "^10.0.0",
-    "winston": "^3.13.0"
+    "winston": "^3.13.0",
+    "zod": "^3.24.3"
   },
   "devDependencies": {
-    "@types/uuid": "^10.0.0",
     "@types/node": "^20.12.7",
+    "@types/uuid": "^10.0.0",
     "tscpaths": "^0.0.9",
     "tsup": "^8.0.2",
     "typescript": "^5.4.5"