@twreporter-academy/api-types 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/schemas/course.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
+
export type JsonValue = string | number | boolean | null | unknown[] | Record<string, unknown>;
|
|
3
|
+
export declare const JsonValueSchema: z.ZodType<JsonValue>;
|
|
2
4
|
export declare const V1CourseSlugPathParamsSchema: z.ZodObject<{
|
|
3
5
|
slug: z.ZodString;
|
|
4
6
|
}, z.core.$strip>;
|
|
@@ -49,7 +51,7 @@ export declare const V1CourseBySlugResponseSchema: z.ZodObject<{
|
|
|
49
51
|
title: z.ZodString;
|
|
50
52
|
subtitle: z.ZodString;
|
|
51
53
|
summary: z.ZodString;
|
|
52
|
-
description: z.
|
|
54
|
+
description: z.ZodNullable<z.ZodType<JsonValue, unknown, z.core.$ZodTypeInternals<JsonValue, unknown>>>;
|
|
53
55
|
status: z.ZodEnum<{
|
|
54
56
|
published: "published";
|
|
55
57
|
coming_soon: "coming_soon";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"course.d.ts","sourceRoot":"","sources":["../../src/schemas/course.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AAEF,eAAO,MAAM,gCAAgC;;;;;;;;iBAI3C,CAAA;AAEF,eAAO,MAAM,oBAAoB;;;;;;;iBAYP,CAAA;AAE1B,eAAO,MAAM,wBAAwB;;;;;;;iBASP,CAAA;AAE9B,eAAO,MAAM,sBAAsB;;;;;iBAQP,CAAA;AAE5B,eAAO,MAAM,4BAA4B;;;;;;iBAQP,CAAA;AAElC,eAAO,MAAM,oBAAoB;;;EAAuC,CAAA;AAExE,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBf,CAAA"}
|
|
1
|
+
{"version":3,"file":"course.d.ts","sourceRoot":"","sources":["../../src/schemas/course.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,MAAM,MAAM,SAAS,GACjB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,OAAO,EAAE,GACT,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAE3B,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAO/C,CAAA;AAEF,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AAEF,eAAO,MAAM,gCAAgC;;;;;;;;iBAI3C,CAAA;AAEF,eAAO,MAAM,oBAAoB;;;;;;;iBAYP,CAAA;AAE1B,eAAO,MAAM,wBAAwB;;;;;;;iBASP,CAAA;AAE9B,eAAO,MAAM,sBAAsB;;;;;iBAQP,CAAA;AAE5B,eAAO,MAAM,4BAA4B;;;;;;iBAQP,CAAA;AAElC,eAAO,MAAM,oBAAoB;;;EAAuC,CAAA;AAExE,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiBf,CAAA"}
|
package/dist/schemas/course.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
import { RestErrorBodySchema } from '../rest.js';
|
|
3
3
|
import { CourseThumbnailSchema, registry } from './tag.js';
|
|
4
|
+
export const JsonValueSchema = z.union([z.string(), z.number(), z.boolean(), z.null(), z.array(z.unknown()), z.record(z.string(), z.unknown())]);
|
|
4
5
|
export const V1CourseSlugPathParamsSchema = z.object({
|
|
5
6
|
slug: z.string().min(1).max(200)
|
|
6
7
|
});
|
|
@@ -48,7 +49,7 @@ export const V1CourseBySlugResponseSchema = z.object({
|
|
|
48
49
|
title: z.string(),
|
|
49
50
|
subtitle: z.string(),
|
|
50
51
|
summary: z.string(),
|
|
51
|
-
description:
|
|
52
|
+
description: JsonValueSchema.nullable(),
|
|
52
53
|
/** published: full payload; coming_soon: lessons/resources/furtherReading/previewVideoId stripped */
|
|
53
54
|
status: V1CourseStatusSchema,
|
|
54
55
|
tags: z.array(z.string()),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"course.js","names":["z","RestErrorBodySchema","CourseThumbnailSchema","registry","V1CourseSlugPathParamsSchema","object","slug","
|
|
1
|
+
{"version":3,"file":"course.js","names":["z","RestErrorBodySchema","CourseThumbnailSchema","registry","JsonValueSchema","union","string","number","boolean","null","array","unknown","record","V1CourseSlugPathParamsSchema","object","slug","min","max","V1CourseBySlugMetaResponseSchema","ogTitle","ogDescription","ogImage","nullable","V1CourseLessonSchema","id","order","int","title","videoId","durationSeconds","isFree","openapi","V1CourseInstructorSchema","name","bio","avatarUrl","V1CourseResourceSchema","description","downloadUrl","V1CourseFurtherReadingSchema","excerpt","thumbnailUrl","url","V1CourseStatusSchema","enum","V1CourseBySlugResponseSchema","subtitle","summary","status","tags","previewVideoId","lessons","instructors","resources","furtherReading","internalServerErrorResponse","content","schema","registerPath","method","path","request","params","responses"],"sources":["../../src/schemas/course.ts"],"sourcesContent":["import { z } from 'zod'\n\nimport { RestErrorBodySchema } from '../rest.js'\nimport { CourseThumbnailSchema, registry } from './tag.js'\n\nexport type JsonValue =\n | string\n | number\n | boolean\n | null\n | unknown[]\n | Record<string, unknown>\n\nexport const JsonValueSchema: z.ZodType<JsonValue> = z.union([\n z.string(),\n z.number(),\n z.boolean(),\n z.null(),\n z.array(z.unknown()),\n z.record(z.string(), z.unknown()),\n])\n\nexport const V1CourseSlugPathParamsSchema = z.object({\n slug: z.string().min(1).max(200),\n})\n\nexport const V1CourseBySlugMetaResponseSchema = z.object({\n ogTitle: z.string(),\n ogDescription: z.string(),\n ogImage: CourseThumbnailSchema.nullable(),\n})\n\nexport const V1CourseLessonSchema = z\n .object({\n id: z.string(),\n order: z.number().int(),\n title: z.string(),\n /** Cloudflare stream id for this lesson; null when not yet set */\n videoId: z.string().nullable(),\n /** Video length in seconds (from CMS); null when not yet set */\n durationSeconds: z.number().int().nullable(),\n /** CMS 免費試看 flag; playback access is decided by user role (out of scope here) */\n isFree: z.boolean(),\n })\n .openapi('CourseLesson')\n\nexport const V1CourseInstructorSchema = z\n .object({\n id: z.string(),\n slug: z.string(),\n name: z.string(),\n title: z.string(),\n bio: z.string(),\n avatarUrl: z.string().nullable(),\n })\n .openapi('CourseInstructor')\n\nexport const V1CourseResourceSchema = z\n .object({\n id: z.string(),\n title: z.string(),\n description: z.string(),\n /** GCS file URL with ?download=true; empty when no PDF uploaded */\n downloadUrl: z.string(),\n })\n .openapi('CourseResource')\n\nexport const V1CourseFurtherReadingSchema = z\n .object({\n id: z.string(),\n title: z.string(),\n excerpt: z.string(),\n thumbnailUrl: z.string().nullable(),\n url: z.string(),\n })\n .openapi('CourseFurtherReading')\n\nexport const V1CourseStatusSchema = z.enum(['published', 'coming_soon'])\n\nexport const V1CourseBySlugResponseSchema = z\n .object({\n slug: z.string(),\n title: z.string(),\n subtitle: z.string(),\n summary: z.string(),\n description: JsonValueSchema.nullable(),\n /** published: full payload; coming_soon: lessons/resources/furtherReading/previewVideoId stripped */\n status: V1CourseStatusSchema,\n tags: z.array(z.string()),\n /** Trial/preview stream only; null when unconfigured or course is coming_soon */\n previewVideoId: z.string().nullable(),\n lessons: z.array(V1CourseLessonSchema),\n instructors: z.array(V1CourseInstructorSchema),\n resources: z.array(V1CourseResourceSchema),\n furtherReading: z.array(V1CourseFurtherReadingSchema),\n })\n .openapi('CourseDetail')\n\n// --- OpenAPI path registration ---\n\nconst internalServerErrorResponse = {\n 500: {\n description: 'Internal server error',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n} as const\n\nregistry.registerPath({\n method: 'get',\n path: '/v1/courses/{slug}/meta',\n tags: ['Courses'],\n description: 'OG metadata for a course page.',\n request: { params: V1CourseSlugPathParamsSchema },\n responses: {\n 200: {\n description: 'Success',\n content: {\n 'application/json': { schema: V1CourseBySlugMetaResponseSchema },\n },\n },\n 400: {\n description: 'Bad request',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n 404: {\n description: 'Course not found',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n ...internalServerErrorResponse,\n },\n})\n\nregistry.registerPath({\n method: 'get',\n path: '/v1/courses/{slug}',\n tags: ['Courses'],\n description:\n 'Full course detail for the classroom page. When status is coming_soon, lessons, resources, furtherReading, and previewVideoId are empty/null while title, description, tags, and instructors remain visible.',\n request: { params: V1CourseSlugPathParamsSchema },\n responses: {\n 200: {\n description: 'Success',\n content: {\n 'application/json': { schema: V1CourseBySlugResponseSchema },\n },\n },\n 400: {\n description: 'Bad request',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n 404: {\n description: 'Course not found',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n ...internalServerErrorResponse,\n },\n})\n"],"mappings":"AAAA,SAASA,CAAC,QAAQ,KAAK;AAEvB,SAASC,mBAAmB,QAAQ,YAAY;AAChD,SAASC,qBAAqB,EAAEC,QAAQ,QAAQ,UAAU;AAU1D,OAAO,MAAMC,eAAqC,GAAGJ,CAAC,CAACK,KAAK,CAAC,CAC3DL,CAAC,CAACM,MAAM,CAAC,CAAC,EACVN,CAAC,CAACO,MAAM,CAAC,CAAC,EACVP,CAAC,CAACQ,OAAO,CAAC,CAAC,EACXR,CAAC,CAACS,IAAI,CAAC,CAAC,EACRT,CAAC,CAACU,KAAK,CAACV,CAAC,CAACW,OAAO,CAAC,CAAC,CAAC,EACpBX,CAAC,CAACY,MAAM,CAACZ,CAAC,CAACM,MAAM,CAAC,CAAC,EAAEN,CAAC,CAACW,OAAO,CAAC,CAAC,CAAC,CAClC,CAAC;AAEF,OAAO,MAAME,4BAA4B,GAAGb,CAAC,CAACc,MAAM,CAAC;EACnDC,IAAI,EAAEf,CAAC,CAACM,MAAM,CAAC,CAAC,CAACU,GAAG,CAAC,CAAC,CAAC,CAACC,GAAG,CAAC,GAAG;AACjC,CAAC,CAAC;AAEF,OAAO,MAAMC,gCAAgC,GAAGlB,CAAC,CAACc,MAAM,CAAC;EACvDK,OAAO,EAAEnB,CAAC,CAACM,MAAM,CAAC,CAAC;EACnBc,aAAa,EAAEpB,CAAC,CAACM,MAAM,CAAC,CAAC;EACzBe,OAAO,EAAEnB,qBAAqB,CAACoB,QAAQ,CAAC;AAC1C,CAAC,CAAC;AAEF,OAAO,MAAMC,oBAAoB,GAAGvB,CAAC,CAClCc,MAAM,CAAC;EACNU,EAAE,EAAExB,CAAC,CAACM,MAAM,CAAC,CAAC;EACdmB,KAAK,EAAEzB,CAAC,CAACO,MAAM,CAAC,CAAC,CAACmB,GAAG,CAAC,CAAC;EACvBC,KAAK,EAAE3B,CAAC,CAACM,MAAM,CAAC,CAAC;EACjB;EACAsB,OAAO,EAAE5B,CAAC,CAACM,MAAM,CAAC,CAAC,CAACgB,QAAQ,CAAC,CAAC;EAC9B;EACAO,eAAe,EAAE7B,CAAC,CAACO,MAAM,CAAC,CAAC,CAACmB,GAAG,CAAC,CAAC,CAACJ,QAAQ,CAAC,CAAC;EAC5C;EACAQ,MAAM,EAAE9B,CAAC,CAACQ,OAAO,CAAC;AACpB,CAAC,CAAC,CACDuB,OAAO,CAAC,cAAc,CAAC;AAE1B,OAAO,MAAMC,wBAAwB,GAAGhC,CAAC,CACtCc,MAAM,CAAC;EACNU,EAAE,EAAExB,CAAC,CAACM,MAAM,CAAC,CAAC;EACdS,IAAI,EAAEf,CAAC,CAACM,MAAM,CAAC,CAAC;EAChB2B,IAAI,EAAEjC,CAAC,CAACM,MAAM,CAAC,CAAC;EAChBqB,KAAK,EAAE3B,CAAC,CAACM,MAAM,CAAC,CAAC;EACjB4B,GAAG,EAAElC,CAAC,CAACM,MAAM,CAAC,CAAC;EACf6B,SAAS,EAAEnC,CAAC,CAACM,MAAM,CAAC,CAAC,CAACgB,QAAQ,CAAC;AACjC,CAAC,CAAC,CACDS,OAAO,CAAC,kBAAkB,CAAC;AAE9B,OAAO,MAAMK,sBAAsB,GAAGpC,CAAC,CACpCc,MAAM,CAAC;EACNU,EAAE,EAAExB,CAAC,CAACM,MAAM,CAAC,CAAC;EACdqB,KAAK,EAAE3B,CAAC,CAACM,MAAM,CAAC,CAAC;EACjB+B,WAAW,EAAErC,CAAC,CAACM,MAAM,CAAC,CAAC;EACvB;EACAgC,WAAW,EAAEtC,CAAC,CAACM,MAAM,CAAC;AACxB,CAAC,CAAC,CACDyB,OAAO,CAAC,gBAAgB,CAAC;AAE5B,OAAO,MAAMQ,4BAA4B,GAAGvC,CAAC,CAC1Cc,MAAM,CAAC;EACNU,EAAE,EAAExB,CAAC,CAACM,MAAM,CAAC,CAAC;EACdqB,KAAK,EAAE3B,CAAC,CAACM,MAAM,CAAC,CAAC;EACjBkC,OAAO,EAAExC,CAAC,CAACM,MAAM,CAAC,CAAC;EACnBmC,YAAY,EAAEzC,CAAC,CAACM,MAAM,CAAC,CAAC,CAACgB,QAAQ,CAAC,CAAC;EACnCoB,GAAG,EAAE1C,CAAC,CAACM,MAAM,CAAC;AAChB,CAAC,CAAC,CACDyB,OAAO,CAAC,sBAAsB,CAAC;AAElC,OAAO,MAAMY,oBAAoB,GAAG3C,CAAC,CAAC4C,IAAI,CAAC,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;AAExE,OAAO,MAAMC,4BAA4B,GAAG7C,CAAC,CAC1Cc,MAAM,CAAC;EACNC,IAAI,EAAEf,CAAC,CAACM,MAAM,CAAC,CAAC;EAChBqB,KAAK,EAAE3B,CAAC,CAACM,MAAM,CAAC,CAAC;EACjBwC,QAAQ,EAAE9C,CAAC,CAACM,MAAM,CAAC,CAAC;EACpByC,OAAO,EAAE/C,CAAC,CAACM,MAAM,CAAC,CAAC;EACnB+B,WAAW,EAAEjC,eAAe,CAACkB,QAAQ,CAAC,CAAC;EACvC;EACA0B,MAAM,EAAEL,oBAAoB;EAC5BM,IAAI,EAAEjD,CAAC,CAACU,KAAK,CAACV,CAAC,CAACM,MAAM,CAAC,CAAC,CAAC;EACzB;EACA4C,cAAc,EAAElD,CAAC,CAACM,MAAM,CAAC,CAAC,CAACgB,QAAQ,CAAC,CAAC;EACrC6B,OAAO,EAAEnD,CAAC,CAACU,KAAK,CAACa,oBAAoB,CAAC;EACtC6B,WAAW,EAAEpD,CAAC,CAACU,KAAK,CAACsB,wBAAwB,CAAC;EAC9CqB,SAAS,EAAErD,CAAC,CAACU,KAAK,CAAC0B,sBAAsB,CAAC;EAC1CkB,cAAc,EAAEtD,CAAC,CAACU,KAAK,CAAC6B,4BAA4B;AACtD,CAAC,CAAC,CACDR,OAAO,CAAC,cAAc,CAAC;;AAE1B;;AAEA,MAAMwB,2BAA2B,GAAG;EAClC,GAAG,EAAE;IACHlB,WAAW,EAAE,uBAAuB;IACpCmB,OAAO,EAAE;MAAE,kBAAkB,EAAE;QAAEC,MAAM,EAAExD;MAAoB;IAAE;EACjE;AACF,CAAU;AAEVE,QAAQ,CAACuD,YAAY,CAAC;EACpBC,MAAM,EAAE,KAAK;EACbC,IAAI,EAAE,yBAAyB;EAC/BX,IAAI,EAAE,CAAC,SAAS,CAAC;EACjBZ,WAAW,EAAE,gCAAgC;EAC7CwB,OAAO,EAAE;IAAEC,MAAM,EAAEjD;EAA6B,CAAC;EACjDkD,SAAS,EAAE;IACT,GAAG,EAAE;MACH1B,WAAW,EAAE,SAAS;MACtBmB,OAAO,EAAE;QACP,kBAAkB,EAAE;UAAEC,MAAM,EAAEvC;QAAiC;MACjE;IACF,CAAC;IACD,GAAG,EAAE;MACHmB,WAAW,EAAE,aAAa;MAC1BmB,OAAO,EAAE;QAAE,kBAAkB,EAAE;UAAEC,MAAM,EAAExD;QAAoB;MAAE;IACjE,CAAC;IACD,GAAG,EAAE;MACHoC,WAAW,EAAE,kBAAkB;MAC/BmB,OAAO,EAAE;QAAE,kBAAkB,EAAE;UAAEC,MAAM,EAAExD;QAAoB;MAAE;IACjE,CAAC;IACD,GAAGsD;EACL;AACF,CAAC,CAAC;AAEFpD,QAAQ,CAACuD,YAAY,CAAC;EACpBC,MAAM,EAAE,KAAK;EACbC,IAAI,EAAE,oBAAoB;EAC1BX,IAAI,EAAE,CAAC,SAAS,CAAC;EACjBZ,WAAW,EACT,8MAA8M;EAChNwB,OAAO,EAAE;IAAEC,MAAM,EAAEjD;EAA6B,CAAC;EACjDkD,SAAS,EAAE;IACT,GAAG,EAAE;MACH1B,WAAW,EAAE,SAAS;MACtBmB,OAAO,EAAE;QACP,kBAAkB,EAAE;UAAEC,MAAM,EAAEZ;QAA6B;MAC7D;IACF,CAAC;IACD,GAAG,EAAE;MACHR,WAAW,EAAE,aAAa;MAC1BmB,OAAO,EAAE;QAAE,kBAAkB,EAAE;UAAEC,MAAM,EAAExD;QAAoB;MAAE;IACjE,CAAC;IACD,GAAG,EAAE;MACHoC,WAAW,EAAE,kBAAkB;MAC/BmB,OAAO,EAAE;QAAE,kBAAkB,EAAE;UAAEC,MAAM,EAAExD;QAAoB;MAAE;IACjE,CAAC;IACD,GAAGsD;EACL;AACF,CAAC,CAAC","ignoreList":[]}
|