@molecule/api-resource-article 1.2.5 → 1.2.6
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/README.md +7 -7
- package/dist/service.d.ts +4 -4
- package/dist/service.d.ts.map +1 -1
- package/dist/service.js +2 -2
- package/dist/types.d.ts +2 -2
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@ AUTO-GENERATED — DO NOT EDIT THIS FILE.
|
|
|
3
3
|
Generated by `mlcl sync-docs` from the package's src/index.ts JSDoc + mlcl/registry.json.
|
|
4
4
|
Edits here are overwritten on the next commit (molecule's pre-commit hook regenerates).
|
|
5
5
|
To change this document, edit the module-level JSDoc in src/index.ts.
|
|
6
|
-
Generated: 2026-11-
|
|
6
|
+
Generated: 2026-11-14T11:16:07.950Z
|
|
7
7
|
-->
|
|
8
8
|
|
|
9
9
|
# @molecule/api-resource-article
|
|
@@ -245,8 +245,8 @@ interface ListArticlesOptions {
|
|
|
245
245
|
limit?: number
|
|
246
246
|
/** Rows to skip. */
|
|
247
247
|
offset?: number
|
|
248
|
-
/** The viewing user, for `favorited
|
|
249
|
-
viewerId?: string
|
|
248
|
+
/** The viewing user, for `favorited`; null or omitted means an anonymous reader. */
|
|
249
|
+
viewerId?: string | null
|
|
250
250
|
}
|
|
251
251
|
```
|
|
252
252
|
|
|
@@ -325,11 +325,11 @@ Turn stored rows into {@link Article}s: decoded tags, favorite counts and the
|
|
|
325
325
|
viewer's own favorites, in two queries for the whole page.
|
|
326
326
|
|
|
327
327
|
```typescript
|
|
328
|
-
function hydrateArticles(rows: ArticleRow[], viewerId?: string): Promise<Article[]>
|
|
328
|
+
function hydrateArticles(rows: ArticleRow[], viewerId?: string | null): Promise<Article[]>
|
|
329
329
|
```
|
|
330
330
|
|
|
331
331
|
- `rows` — Article rows.
|
|
332
|
-
- `viewerId` — The viewing user, if any.
|
|
332
|
+
- `viewerId` — The viewing user, if any; null and undefined are anonymous.
|
|
333
333
|
|
|
334
334
|
**Returns:** The articles, in the order given.
|
|
335
335
|
|
|
@@ -367,11 +367,11 @@ function findArticleRow(slug: string): Promise<ArticleRow | null>
|
|
|
367
367
|
An article by slug.
|
|
368
368
|
|
|
369
369
|
```typescript
|
|
370
|
-
function getArticleBySlug(slug: string, viewerId?: string): Promise<Article | null>
|
|
370
|
+
function getArticleBySlug(slug: string, viewerId?: string | null): Promise<Article | null>
|
|
371
371
|
```
|
|
372
372
|
|
|
373
373
|
- `slug` — The article slug.
|
|
374
|
-
- `viewerId` — The viewing user, for `favorited
|
|
374
|
+
- `viewerId` — The viewing user, for `favorited`; null or omitted is anonymous.
|
|
375
375
|
|
|
376
376
|
**Returns:** The article, or null.
|
|
377
377
|
|
package/dist/service.d.ts
CHANGED
|
@@ -27,10 +27,10 @@ export declare const MAX_ARTICLES_PAGE = 100;
|
|
|
27
27
|
* viewer's own favorites, in two queries for the whole page.
|
|
28
28
|
*
|
|
29
29
|
* @param rows - Article rows.
|
|
30
|
-
* @param viewerId - The viewing user, if any.
|
|
30
|
+
* @param viewerId - The viewing user, if any; null and undefined are anonymous.
|
|
31
31
|
* @returns The articles, in the order given.
|
|
32
32
|
*/
|
|
33
|
-
export declare function hydrateArticles(rows: ArticleRow[], viewerId?: string): Promise<Article[]>;
|
|
33
|
+
export declare function hydrateArticles(rows: ArticleRow[], viewerId?: string | null): Promise<Article[]>;
|
|
34
34
|
/**
|
|
35
35
|
* Create an article with a unique slug derived from its title.
|
|
36
36
|
*
|
|
@@ -54,10 +54,10 @@ export declare function findArticleRow(slug: string): Promise<ArticleRow | null>
|
|
|
54
54
|
* An article by slug.
|
|
55
55
|
*
|
|
56
56
|
* @param slug - The article slug.
|
|
57
|
-
* @param viewerId - The viewing user, for `favorited
|
|
57
|
+
* @param viewerId - The viewing user, for `favorited`; null or omitted is anonymous.
|
|
58
58
|
* @returns The article, or null.
|
|
59
59
|
*/
|
|
60
|
-
export declare function getArticleBySlug(slug: string, viewerId?: string): Promise<Article | null>;
|
|
60
|
+
export declare function getArticleBySlug(slug: string, viewerId?: string | null): Promise<Article | null>;
|
|
61
61
|
/**
|
|
62
62
|
* Articles newest first, filtered by tag, author and who favorited them.
|
|
63
63
|
*
|
package/dist/service.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAeH,OAAO,KAAK,EACV,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,kBAAkB,EACnB,MAAM,YAAY,CAAA;AAOnB,6EAA6E;AAC7E,eAAO,MAAM,qBAAqB,YAAY,CAAA;AAE9C,iDAAiD;AACjD,eAAO,MAAM,iBAAiB,aAAa,CAAA;AAE3C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,WAAW,CAAC,MAAM,CAA6B,CAAA;AA0CpF,mCAAmC;AACnC,eAAO,MAAM,iBAAiB,MAAM,CAAA;AAyBpC;;;;;;;GAOG;AACH,wBAAsB,eAAe,
|
|
1
|
+
{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAeH,OAAO,KAAK,EACV,OAAO,EACP,UAAU,EACV,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,kBAAkB,EACnB,MAAM,YAAY,CAAA;AAOnB,6EAA6E;AAC7E,eAAO,MAAM,qBAAqB,YAAY,CAAA;AAE9C,iDAAiD;AACjD,eAAO,MAAM,iBAAiB,aAAa,CAAA;AAE3C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,WAAW,CAAC,MAAM,CAA6B,CAAA;AA0CpF,mCAAmC;AACnC,eAAO,MAAM,iBAAiB,MAAM,CAAA;AAyBpC;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,IAAI,EAAE,UAAU,EAAE,EAClB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GACvB,OAAO,CAAC,OAAO,EAAE,CAAC,CA6BpB;AAsBD;;;;;;;;;;GAUG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,CAsBjG;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAE7E;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GACvB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAKzB;AAkCD;;;;;GAKG;AACH,wBAAsB,YAAY,CAAC,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAoBhG;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GAChD,OAAO,CAAC,iBAAiB,CAAC,CAsB5B;AAED,6DAA6D;AAC7D,MAAM,MAAM,YAAY,CAAC,CAAC,IACxB;IAAE,MAAM,EAAE,IAAI,CAAC;IAAC,OAAO,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,GAAG;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAAA;AAElF;;;;;;;;;;;GAWG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAkBhC;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAW7F;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAOzB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAEnD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,WAAW,CAAC,KAAK,SAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAEjE"}
|
package/dist/service.js
CHANGED
|
@@ -83,7 +83,7 @@ const cleanTags = (tags) => [
|
|
|
83
83
|
* viewer's own favorites, in two queries for the whole page.
|
|
84
84
|
*
|
|
85
85
|
* @param rows - Article rows.
|
|
86
|
-
* @param viewerId - The viewing user, if any.
|
|
86
|
+
* @param viewerId - The viewing user, if any; null and undefined are anonymous.
|
|
87
87
|
* @returns The articles, in the order given.
|
|
88
88
|
*/
|
|
89
89
|
export async function hydrateArticles(rows, viewerId) {
|
|
@@ -183,7 +183,7 @@ export async function findArticleRow(slug) {
|
|
|
183
183
|
* An article by slug.
|
|
184
184
|
*
|
|
185
185
|
* @param slug - The article slug.
|
|
186
|
-
* @param viewerId - The viewing user, for `favorited
|
|
186
|
+
* @param viewerId - The viewing user, for `favorited`; null or omitted is anonymous.
|
|
187
187
|
* @returns The article, or null.
|
|
188
188
|
*/
|
|
189
189
|
export async function getArticleBySlug(slug, viewerId) {
|
package/dist/types.d.ts
CHANGED
|
@@ -94,8 +94,8 @@ export interface ListArticlesOptions {
|
|
|
94
94
|
limit?: number;
|
|
95
95
|
/** Rows to skip. */
|
|
96
96
|
offset?: number;
|
|
97
|
-
/** The viewing user, for `favorited
|
|
98
|
-
viewerId?: string;
|
|
97
|
+
/** The viewing user, for `favorited`; null or omitted means an anonymous reader. */
|
|
98
|
+
viewerId?: string | null;
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
101
|
* A page of articles.
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa;IACb,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAA;IACjB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa;IACb,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,+CAA+C;IAC/C,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAA;IACjB,mCAAmC;IACnC,cAAc,EAAE,MAAM,CAAA;IACtB,sEAAsE;IACtE,SAAS,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,qBAAqB;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa;IACb,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAA;IACjB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,iCAAiC;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa;IACb,KAAK,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,+CAA+C;IAC/C,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAA;IACjB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAA;IACjB,mCAAmC;IACnC,cAAc,EAAE,MAAM,CAAA;IACtB,sEAAsE;IACtE,SAAS,EAAE,OAAO,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,qBAAqB;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,iBAAiB;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,6CAA6C;IAC7C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oFAAoF;IACpF,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,IAAI,EAAE,OAAO,EAAE,CAAA;IACf,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAA;IACb,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,gBAAgB;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAA;CACd"}
|
package/package.json
CHANGED