@twreporter-academy/api-types 0.0.25 → 0.0.26
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/openapi.d.ts
CHANGED
|
@@ -24,7 +24,7 @@ export declare function getOpenApiDocument(): {
|
|
|
24
24
|
readonly description: "Header posts and the public post catalog.";
|
|
25
25
|
} | {
|
|
26
26
|
readonly name: "Activities";
|
|
27
|
-
readonly description: "
|
|
27
|
+
readonly description: "Header activities and the public activity catalog.";
|
|
28
28
|
} | {
|
|
29
29
|
readonly name: "Home";
|
|
30
30
|
readonly description: "Home page data including posts, activities, and courses.";
|
package/dist/openapi.js
CHANGED
|
@@ -26,7 +26,7 @@ const openApiRootTags = [{
|
|
|
26
26
|
description: 'Header posts and the public post catalog.'
|
|
27
27
|
}, {
|
|
28
28
|
name: 'Activities',
|
|
29
|
-
description: '
|
|
29
|
+
description: 'Header activities and the public activity catalog.'
|
|
30
30
|
}, {
|
|
31
31
|
name: 'Home',
|
|
32
32
|
description: 'Home page data including posts, activities, and courses.'
|
package/dist/openapi.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openapi.js","names":["OpenApiGeneratorV3","registry","openApiRootTags","name","description","getOpenApiDocument","generator","definitions","generateDocument","openapi","info","title","version","tags"],"sources":["../src/openapi.ts"],"sourcesContent":["// Side-effect imports: ensure OpenAPI paths are registered before generation.\nimport './schemas/activity.js'\nimport './schemas/course.js'\nimport './schemas/member.js'\nimport './schemas/post.js'\nimport './schemas/home.js'\n\nimport { OpenApiGeneratorV3 } from '@asteasolutions/zod-to-openapi'\n\nimport { registry } from './schemas/registry.js'\n\nconst openApiRootTags = [\n { name: 'Auth', description: 'Token exchange and session management.' },\n { name: 'Members', description: 'Authenticated member profile.' },\n {\n name: 'Admin',\n description: 'Privileged operations requiring GCP IAM authentication.',\n },\n { name: 'Tags', description: 'Tag metadata and course feeds by slug.' },\n { name: 'Courses', description: 'Course metadata and classroom detail.' },\n { name: 'Posts', description: 'Header posts and the public post catalog.' },\n {\n name: 'Activities',\n description: '
|
|
1
|
+
{"version":3,"file":"openapi.js","names":["OpenApiGeneratorV3","registry","openApiRootTags","name","description","getOpenApiDocument","generator","definitions","generateDocument","openapi","info","title","version","tags"],"sources":["../src/openapi.ts"],"sourcesContent":["// Side-effect imports: ensure OpenAPI paths are registered before generation.\nimport './schemas/activity.js'\nimport './schemas/course.js'\nimport './schemas/member.js'\nimport './schemas/post.js'\nimport './schemas/home.js'\n\nimport { OpenApiGeneratorV3 } from '@asteasolutions/zod-to-openapi'\n\nimport { registry } from './schemas/registry.js'\n\nconst openApiRootTags = [\n { name: 'Auth', description: 'Token exchange and session management.' },\n { name: 'Members', description: 'Authenticated member profile.' },\n {\n name: 'Admin',\n description: 'Privileged operations requiring GCP IAM authentication.',\n },\n { name: 'Tags', description: 'Tag metadata and course feeds by slug.' },\n { name: 'Courses', description: 'Course metadata and classroom detail.' },\n { name: 'Posts', description: 'Header posts and the public post catalog.' },\n {\n name: 'Activities',\n description: 'Header activities and the public activity catalog.',\n },\n {\n name: 'Home',\n description: 'Home page data including posts, activities, and courses.',\n },\n] as const\n\nexport function getOpenApiDocument() {\n const generator = new OpenApiGeneratorV3(registry.definitions)\n return {\n ...generator.generateDocument({\n openapi: '3.0.3',\n info: {\n title: 'TWReporter Academy API',\n version: '0.0.1',\n description:\n 'Academy content API. Serves tag metadata, course feeds, and classroom detail.',\n },\n }),\n tags: [...openApiRootTags],\n }\n}\n"],"mappings":"AAAA;AACA,OAAO,uBAAuB;AAC9B,OAAO,qBAAqB;AAC5B,OAAO,qBAAqB;AAC5B,OAAO,mBAAmB;AAC1B,OAAO,mBAAmB;AAE1B,SAASA,kBAAkB,QAAQ,gCAAgC;AAEnE,SAASC,QAAQ,QAAQ,uBAAuB;AAEhD,MAAMC,eAAe,GAAG,CACtB;EAAEC,IAAI,EAAE,MAAM;EAAEC,WAAW,EAAE;AAAyC,CAAC,EACvE;EAAED,IAAI,EAAE,SAAS;EAAEC,WAAW,EAAE;AAAgC,CAAC,EACjE;EACED,IAAI,EAAE,OAAO;EACbC,WAAW,EAAE;AACf,CAAC,EACD;EAAED,IAAI,EAAE,MAAM;EAAEC,WAAW,EAAE;AAAyC,CAAC,EACvE;EAAED,IAAI,EAAE,SAAS;EAAEC,WAAW,EAAE;AAAwC,CAAC,EACzE;EAAED,IAAI,EAAE,OAAO;EAAEC,WAAW,EAAE;AAA4C,CAAC,EAC3E;EACED,IAAI,EAAE,YAAY;EAClBC,WAAW,EAAE;AACf,CAAC,EACD;EACED,IAAI,EAAE,MAAM;EACZC,WAAW,EAAE;AACf,CAAC,CACO;AAEV,OAAO,SAASC,kBAAkBA,CAAA,EAAG;EACnC,MAAMC,SAAS,GAAG,IAAIN,kBAAkB,CAACC,QAAQ,CAACM,WAAW,CAAC;EAC9D,OAAO;IACL,GAAGD,SAAS,CAACE,gBAAgB,CAAC;MAC5BC,OAAO,EAAE,OAAO;MAChBC,IAAI,EAAE;QACJC,KAAK,EAAE,wBAAwB;QAC/BC,OAAO,EAAE,OAAO;QAChBR,WAAW,EACT;MACJ;IACF,CAAC,CAAC;IACFS,IAAI,EAAE,CAAC,GAAGX,eAAe;EAC3B,CAAC;AACH","ignoreList":[]}
|
|
@@ -16,4 +16,46 @@ export declare const V1ActivitiesListResponseSchema: z.ZodObject<{
|
|
|
16
16
|
featured: z.ZodBoolean;
|
|
17
17
|
}, z.core.$strip>>;
|
|
18
18
|
}, z.core.$strip>;
|
|
19
|
+
export declare const V1ActivityCatalogItemSchema: z.ZodObject<{
|
|
20
|
+
title: z.ZodString;
|
|
21
|
+
description: z.ZodString;
|
|
22
|
+
link: z.ZodString;
|
|
23
|
+
image: z.ZodNullable<z.ZodObject<{
|
|
24
|
+
title: z.ZodString;
|
|
25
|
+
resized: z.ZodObject<{
|
|
26
|
+
tiny: z.ZodString;
|
|
27
|
+
small: z.ZodString;
|
|
28
|
+
medium: z.ZodString;
|
|
29
|
+
large: z.ZodString;
|
|
30
|
+
}, z.core.$strip>;
|
|
31
|
+
}, z.core.$strip>>;
|
|
32
|
+
badgeText: z.ZodString;
|
|
33
|
+
buttonText: z.ZodString;
|
|
34
|
+
tags: z.ZodArray<z.ZodObject<{
|
|
35
|
+
slug: z.ZodString;
|
|
36
|
+
name: z.ZodString;
|
|
37
|
+
}, z.core.$strip>>;
|
|
38
|
+
}, z.core.$strip>;
|
|
39
|
+
export declare const V1ActivitiesCatalogResponseSchema: z.ZodObject<{
|
|
40
|
+
activities: z.ZodArray<z.ZodObject<{
|
|
41
|
+
title: z.ZodString;
|
|
42
|
+
description: z.ZodString;
|
|
43
|
+
link: z.ZodString;
|
|
44
|
+
image: z.ZodNullable<z.ZodObject<{
|
|
45
|
+
title: z.ZodString;
|
|
46
|
+
resized: z.ZodObject<{
|
|
47
|
+
tiny: z.ZodString;
|
|
48
|
+
small: z.ZodString;
|
|
49
|
+
medium: z.ZodString;
|
|
50
|
+
large: z.ZodString;
|
|
51
|
+
}, z.core.$strip>;
|
|
52
|
+
}, z.core.$strip>>;
|
|
53
|
+
badgeText: z.ZodString;
|
|
54
|
+
buttonText: z.ZodString;
|
|
55
|
+
tags: z.ZodArray<z.ZodObject<{
|
|
56
|
+
slug: z.ZodString;
|
|
57
|
+
name: z.ZodString;
|
|
58
|
+
}, z.core.$strip>>;
|
|
59
|
+
}, z.core.$strip>>;
|
|
60
|
+
}, z.core.$strip>;
|
|
19
61
|
//# sourceMappingURL=activity.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../src/schemas/activity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../src/schemas/activity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAMvB,eAAO,MAAM,2BAA2B;;iBAEtC,CAAA;AAEF,eAAO,MAAM,0BAA0B;;;;;iBAOP,CAAA;AAEhC,eAAO,MAAM,8BAA8B;;;;;;;iBAIP,CAAA;AAEpC,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;iBAEP,CAAA;AAEjC,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;iBAIP,CAAA"}
|
package/dist/schemas/activity.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
2
|
import { RestErrorBodySchema } from '../rest.js';
|
|
3
|
+
import { V1HomeActivityCardSchema } from './home.js';
|
|
3
4
|
import { registry } from './registry.js';
|
|
4
5
|
export const V1ActivitiesListQuerySchema = z.object({
|
|
5
6
|
take: z.coerce.number().int().min(1).max(10).optional()
|
|
@@ -13,6 +14,15 @@ export const V1HeaderActivityItemSchema = z.object({
|
|
|
13
14
|
export const V1ActivitiesListResponseSchema = z.object({
|
|
14
15
|
activities: z.array(V1HeaderActivityItemSchema)
|
|
15
16
|
}).openapi('ActivitiesListResponse');
|
|
17
|
+
export const V1ActivityCatalogItemSchema = V1HomeActivityCardSchema.extend({
|
|
18
|
+
tags: z.array(z.object({
|
|
19
|
+
slug: z.string(),
|
|
20
|
+
name: z.string()
|
|
21
|
+
}))
|
|
22
|
+
}).openapi('ActivityCatalogItem');
|
|
23
|
+
export const V1ActivitiesCatalogResponseSchema = z.object({
|
|
24
|
+
activities: z.array(V1ActivityCatalogItemSchema)
|
|
25
|
+
}).openapi('ActivitiesCatalogResponse');
|
|
16
26
|
registry.registerPath({
|
|
17
27
|
method: 'get',
|
|
18
28
|
path: '/v1/activities',
|
|
@@ -48,4 +58,28 @@ registry.registerPath({
|
|
|
48
58
|
}
|
|
49
59
|
}
|
|
50
60
|
});
|
|
61
|
+
registry.registerPath({
|
|
62
|
+
method: 'get',
|
|
63
|
+
path: '/v1/activities/catalog',
|
|
64
|
+
tags: ['Activities'],
|
|
65
|
+
description: 'Public activity catalog.',
|
|
66
|
+
responses: {
|
|
67
|
+
200: {
|
|
68
|
+
description: 'Success',
|
|
69
|
+
content: {
|
|
70
|
+
'application/json': {
|
|
71
|
+
schema: V1ActivitiesCatalogResponseSchema
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
500: {
|
|
76
|
+
description: 'Internal server error',
|
|
77
|
+
content: {
|
|
78
|
+
'application/json': {
|
|
79
|
+
schema: RestErrorBodySchema
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
});
|
|
51
85
|
//# sourceMappingURL=activity.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"activity.js","names":["z","RestErrorBodySchema","registry","V1ActivitiesListQuerySchema","object","take","coerce","number","int","min","max","optional","V1HeaderActivityItemSchema","title","string","imageUrl","nullable","href","featured","boolean","openapi","V1ActivitiesListResponseSchema","activities","array","registerPath","method","path","
|
|
1
|
+
{"version":3,"file":"activity.js","names":["z","RestErrorBodySchema","V1HomeActivityCardSchema","registry","V1ActivitiesListQuerySchema","object","take","coerce","number","int","min","max","optional","V1HeaderActivityItemSchema","title","string","imageUrl","nullable","href","featured","boolean","openapi","V1ActivitiesListResponseSchema","activities","array","V1ActivityCatalogItemSchema","extend","tags","slug","name","V1ActivitiesCatalogResponseSchema","registerPath","method","path","description","request","query","responses","content","schema"],"sources":["../../src/schemas/activity.ts"],"sourcesContent":["import { z } from 'zod'\n\nimport { RestErrorBodySchema } from '../rest.js'\nimport { V1HomeActivityCardSchema } from './home.js'\nimport { registry } from './registry.js'\n\nexport const V1ActivitiesListQuerySchema = z.object({\n take: z.coerce.number().int().min(1).max(10).optional(),\n})\n\nexport const V1HeaderActivityItemSchema = z\n .object({\n title: z.string(),\n imageUrl: z.string().nullable(),\n href: z.string(),\n featured: z.boolean(),\n })\n .openapi('HeaderActivityItem')\n\nexport const V1ActivitiesListResponseSchema = z\n .object({\n activities: z.array(V1HeaderActivityItemSchema),\n })\n .openapi('ActivitiesListResponse')\n\nexport const V1ActivityCatalogItemSchema = V1HomeActivityCardSchema.extend({\n tags: z.array(z.object({ slug: z.string(), name: z.string() })),\n}).openapi('ActivityCatalogItem')\n\nexport const V1ActivitiesCatalogResponseSchema = z\n .object({\n activities: z.array(V1ActivityCatalogItemSchema),\n })\n .openapi('ActivitiesCatalogResponse')\n\nregistry.registerPath({\n method: 'get',\n path: '/v1/activities',\n tags: ['Activities'],\n description: 'Latest activities for header.',\n request: { query: V1ActivitiesListQuerySchema },\n responses: {\n 200: {\n description: 'Success',\n content: {\n 'application/json': { schema: V1ActivitiesListResponseSchema },\n },\n },\n 400: {\n description: 'Invalid request',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n 500: {\n description: 'Internal server error',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n },\n})\n\nregistry.registerPath({\n method: 'get',\n path: '/v1/activities/catalog',\n tags: ['Activities'],\n description: 'Public activity catalog.',\n responses: {\n 200: {\n description: 'Success',\n content: {\n 'application/json': { schema: V1ActivitiesCatalogResponseSchema },\n },\n },\n 500: {\n description: 'Internal server error',\n content: { 'application/json': { schema: RestErrorBodySchema } },\n },\n },\n})\n"],"mappings":"AAAA,SAASA,CAAC,QAAQ,KAAK;AAEvB,SAASC,mBAAmB,QAAQ,YAAY;AAChD,SAASC,wBAAwB,QAAQ,WAAW;AACpD,SAASC,QAAQ,QAAQ,eAAe;AAExC,OAAO,MAAMC,2BAA2B,GAAGJ,CAAC,CAACK,MAAM,CAAC;EAClDC,IAAI,EAAEN,CAAC,CAACO,MAAM,CAACC,MAAM,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC,CAACC,GAAG,CAAC,CAAC,CAAC,CAACC,GAAG,CAAC,EAAE,CAAC,CAACC,QAAQ,CAAC;AACxD,CAAC,CAAC;AAEF,OAAO,MAAMC,0BAA0B,GAAGb,CAAC,CACxCK,MAAM,CAAC;EACNS,KAAK,EAAEd,CAAC,CAACe,MAAM,CAAC,CAAC;EACjBC,QAAQ,EAAEhB,CAAC,CAACe,MAAM,CAAC,CAAC,CAACE,QAAQ,CAAC,CAAC;EAC/BC,IAAI,EAAElB,CAAC,CAACe,MAAM,CAAC,CAAC;EAChBI,QAAQ,EAAEnB,CAAC,CAACoB,OAAO,CAAC;AACtB,CAAC,CAAC,CACDC,OAAO,CAAC,oBAAoB,CAAC;AAEhC,OAAO,MAAMC,8BAA8B,GAAGtB,CAAC,CAC5CK,MAAM,CAAC;EACNkB,UAAU,EAAEvB,CAAC,CAACwB,KAAK,CAACX,0BAA0B;AAChD,CAAC,CAAC,CACDQ,OAAO,CAAC,wBAAwB,CAAC;AAEpC,OAAO,MAAMI,2BAA2B,GAAGvB,wBAAwB,CAACwB,MAAM,CAAC;EACzEC,IAAI,EAAE3B,CAAC,CAACwB,KAAK,CAACxB,CAAC,CAACK,MAAM,CAAC;IAAEuB,IAAI,EAAE5B,CAAC,CAACe,MAAM,CAAC,CAAC;IAAEc,IAAI,EAAE7B,CAAC,CAACe,MAAM,CAAC;EAAE,CAAC,CAAC;AAChE,CAAC,CAAC,CAACM,OAAO,CAAC,qBAAqB,CAAC;AAEjC,OAAO,MAAMS,iCAAiC,GAAG9B,CAAC,CAC/CK,MAAM,CAAC;EACNkB,UAAU,EAAEvB,CAAC,CAACwB,KAAK,CAACC,2BAA2B;AACjD,CAAC,CAAC,CACDJ,OAAO,CAAC,2BAA2B,CAAC;AAEvClB,QAAQ,CAAC4B,YAAY,CAAC;EACpBC,MAAM,EAAE,KAAK;EACbC,IAAI,EAAE,gBAAgB;EACtBN,IAAI,EAAE,CAAC,YAAY,CAAC;EACpBO,WAAW,EAAE,+BAA+B;EAC5CC,OAAO,EAAE;IAAEC,KAAK,EAAEhC;EAA4B,CAAC;EAC/CiC,SAAS,EAAE;IACT,GAAG,EAAE;MACHH,WAAW,EAAE,SAAS;MACtBI,OAAO,EAAE;QACP,kBAAkB,EAAE;UAAEC,MAAM,EAAEjB;QAA+B;MAC/D;IACF,CAAC;IACD,GAAG,EAAE;MACHY,WAAW,EAAE,iBAAiB;MAC9BI,OAAO,EAAE;QAAE,kBAAkB,EAAE;UAAEC,MAAM,EAAEtC;QAAoB;MAAE;IACjE,CAAC;IACD,GAAG,EAAE;MACHiC,WAAW,EAAE,uBAAuB;MACpCI,OAAO,EAAE;QAAE,kBAAkB,EAAE;UAAEC,MAAM,EAAEtC;QAAoB;MAAE;IACjE;EACF;AACF,CAAC,CAAC;AAEFE,QAAQ,CAAC4B,YAAY,CAAC;EACpBC,MAAM,EAAE,KAAK;EACbC,IAAI,EAAE,wBAAwB;EAC9BN,IAAI,EAAE,CAAC,YAAY,CAAC;EACpBO,WAAW,EAAE,0BAA0B;EACvCG,SAAS,EAAE;IACT,GAAG,EAAE;MACHH,WAAW,EAAE,SAAS;MACtBI,OAAO,EAAE;QACP,kBAAkB,EAAE;UAAEC,MAAM,EAAET;QAAkC;MAClE;IACF,CAAC;IACD,GAAG,EAAE;MACHI,WAAW,EAAE,uBAAuB;MACpCI,OAAO,EAAE;QAAE,kBAAkB,EAAE;UAAEC,MAAM,EAAEtC;QAAoB;MAAE;IACjE;EACF;AACF,CAAC,CAAC","ignoreList":[]}
|