@epic-web/workshop-utils 0.0.0-semantically-released

package/dist/esm/epic-api.server.d.ts

@@ -0,0 +1,227 @@
+import { z } from 'zod';
+import { type Timings } from './timing.server.js';
+export type EpicVideoInfos = Record<string, Awaited<ReturnType<typeof getEpicVideoInfo>>>;
+export declare function getEpicVideoInfos(epicWebUrls?: Array<string> | null, { request, timings }?: {
+    request?: Request;
+    timings?: Timings;
+}): Promise<EpicVideoInfos>;
+declare function getEpicVideoInfo({ epicVideoEmbed, accessToken, request, timings, }: {
+    epicVideoEmbed: string;
+    accessToken?: string;
+    request?: Request;
+    timings?: Timings;
+}): Promise<{
+    status: "success";
+    transcript: string;
+    muxPlaybackId: string;
+    statusCode: number;
+    statusText: string;
+    title?: string | null | undefined;
+} | {
+    status: "error";
+    type: "unknown";
+    statusCode: number;
+    statusText: string;
+} | {
+    status: "error";
+    type: "region-restricted";
+    requestCountry: string;
+    restrictedCountry: string;
+    statusCode: number;
+    statusText: string;
+} | null>;
+export type Progress = Awaited<ReturnType<typeof getProgress>>[number];
+export declare function getProgress({ timings, request, }?: {
+    timings?: Timings;
+    request?: Request;
+}): Promise<({
+    epicLessonUrl: string;
+    epicLessonSlug: string;
+    epicCompletedAt: string | null;
+} & ({
+    readonly type: "workshop-instructions";
+    readonly exerciseNumber?: undefined;
+    readonly stepNumber?: undefined;
+} | {
+    readonly type: "workshop-finished";
+    readonly exerciseNumber?: undefined;
+    readonly stepNumber?: undefined;
+} | {
+    readonly type: "instructions";
+    readonly exerciseNumber: number;
+    readonly stepNumber?: undefined;
+} | {
+    readonly type: "finished";
+    readonly exerciseNumber: number;
+    readonly stepNumber?: undefined;
+} | {
+    readonly type: "step";
+    readonly exerciseNumber: number;
+    readonly stepNumber: number;
+} | {
+    type: "unknown";
+} | undefined))[]>;
+export declare function updateProgress({ lessonSlug, complete }: {
+    lessonSlug: string;
+    complete?: boolean;
+}, { timings, request, }?: {
+    timings?: Timings;
+    request?: Request;
+}): Promise<{
+    readonly status: "error";
+    readonly error: "cannot update progress when deployed";
+} | {
+    readonly status: "error";
+    readonly error: "not authenticated";
+} | {
+    readonly status: "error";
+    readonly error: `${number} ${string}`;
+} | {
+    readonly status: "success";
+    readonly error?: undefined;
+}>;
+export declare function getWorkshopData(slug: string, { timings, request, forceFresh, }?: {
+    timings?: Timings;
+    request?: Request;
+    forceFresh?: boolean;
+}): Promise<{
+    resources: ({
+        slug: string;
+        _type: "lesson";
+        _id: string;
+    } | {
+        _type: "section";
+        lessons: {
+            slug: string;
+            _id: string;
+        }[];
+    })[] | null;
+}>;
+export declare function userHasAccessToWorkshop({ timings, request, forceFresh, }?: {
+    request?: Request;
+    timings?: Timings;
+    forceFresh?: boolean;
+}): Promise<boolean>;
+declare const UserInfoSchema: z.ZodEffects<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    email: z.ZodString;
+    image: z.ZodNullable<z.ZodString>;
+    discordProfile: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        nick: z.ZodNullable<z.ZodString>;
+        user: z.ZodObject<{
+            id: z.ZodString;
+            username: z.ZodString;
+            avatar: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            global_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        }, {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        nick: string | null;
+        user: {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        };
+    }, {
+        nick: string | null;
+        user: {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        };
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    name: string | null;
+    id: string;
+    email: string;
+    image: string | null;
+    discordProfile?: {
+        nick: string | null;
+        user: {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        };
+    } | null | undefined;
+}, {
+    name: string | null;
+    id: string;
+    email: string;
+    image: string | null;
+    discordProfile?: {
+        nick: string | null;
+        user: {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        };
+    } | null | undefined;
+}>, {
+    imageUrlSmall: string | null;
+    imageUrlLarge: string | null;
+    name: string | null;
+    id: string;
+    email: string;
+    image: string | null;
+    discordProfile?: {
+        nick: string | null;
+        user: {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        };
+    } | null | undefined;
+}, {
+    name: string | null;
+    id: string;
+    email: string;
+    image: string | null;
+    discordProfile?: {
+        nick: string | null;
+        user: {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        };
+    } | null | undefined;
+}>;
+export type UserInfo = z.infer<typeof UserInfoSchema>;
+export declare function getUserInfo({ timings, request, forceFresh, }?: {
+    timings?: Timings;
+    request?: Request;
+    forceFresh?: boolean;
+}): Promise<{
+    imageUrlSmall: string | null;
+    imageUrlLarge: string | null;
+    name: string | null;
+    id: string;
+    email: string;
+    image: string | null;
+    discordProfile?: {
+        nick: string | null;
+        user: {
+            id: string;
+            username: string;
+            avatar?: string | null | undefined;
+            global_name?: string | null | undefined;
+        };
+    } | null | undefined;
+} | null>;
+export {};
+//# sourceMappingURL=epic-api.server.d.ts.map

package/dist/esm/epic-api.server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"epic-api.server.d.ts","sourceRoot":"","sources":["../../src/epic-api.server.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AASvB,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAiDjD,MAAM,MAAM,cAAc,GAAG,MAAM,CAClC,MAAM,EACN,OAAO,CAAC,UAAU,CAAC,OAAO,gBAAgB,CAAC,CAAC,CAC5C,CAAA;AAED,wBAAsB,iBAAiB,CACtC,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,EAClC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAO,2BAmBnE;AAED,iBAAe,gBAAgB,CAAC,EAC/B,cAAc,EACd,WAAW,EACX,OAAO,EACP,OAAO,GACP,EAAE;IACF,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;CACjB;;;;;;;;;;;;;;;;;;;UAuGA;AAmFD,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AACtE,wBAAsB,WAAW,CAAC,EACjC,OAAO,EACP,OAAO,GACP,GAAE;IACF,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;CACZ;mBAwBW,MAAM;oBACL,MAAM;qBACL,MAAM,GAAG,IAAI;;;;;;;;;;;;;;;;;;;;;;UAIsB,SAAS;mBAoC9D;AAqDD,wBAAsB,cAAc,CACnC,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,EACpE,EACC,OAAO,EACP,OAAO,GACP,GAAE;IACF,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;CACZ;;;;;;;;;;;;GAqCN;AAoBD,wBAAsB,eAAe,CACpC,IAAI,EAAE,MAAM,EACZ,EACC,OAAO,EACP,OAAO,EACP,UAAU,GACV,GAAE;IACF,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,OAAO,CAAA;CACf;;;;;;;;;;;;GAkCN;AAED,wBAAsB,uBAAuB,CAAC,EAC7C,OAAO,EACP,OAAO,EACP,UAAU,GACV,GAAE;IACF,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,OAAO,CAAA;CACf,oBA6CL;AAED,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmCjB,CAAA;AAwCH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAErD,wBAAsB,WAAW,CAAC,EACjC,OAAO,EACP,OAAO,EACP,UAAU,GACV,GAAE;IACF,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,OAAO,CAAA;CACf;;;;;;;;;;;;;;;;UAwDL"}