@stego-labs/shared 1.0.1

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.
Files changed (106) hide show
  1. package/README.md +13 -0
  2. package/dist/contracts/cli/comments.d.ts +98 -0
  3. package/dist/contracts/cli/comments.d.ts.map +1 -0
  4. package/dist/contracts/cli/comments.js +2 -0
  5. package/dist/contracts/cli/comments.js.map +1 -0
  6. package/dist/contracts/cli/envelopes.d.ts +23 -0
  7. package/dist/contracts/cli/envelopes.d.ts.map +1 -0
  8. package/dist/contracts/cli/envelopes.js +20 -0
  9. package/dist/contracts/cli/envelopes.js.map +1 -0
  10. package/dist/contracts/cli/errors.d.ts +8 -0
  11. package/dist/contracts/cli/errors.d.ts.map +1 -0
  12. package/dist/contracts/cli/errors.js +15 -0
  13. package/dist/contracts/cli/errors.js.map +1 -0
  14. package/dist/contracts/cli/exit-codes.d.ts +3 -0
  15. package/dist/contracts/cli/exit-codes.d.ts.map +1 -0
  16. package/dist/contracts/cli/exit-codes.js +16 -0
  17. package/dist/contracts/cli/exit-codes.js.map +1 -0
  18. package/dist/contracts/cli/index.d.ts +7 -0
  19. package/dist/contracts/cli/index.d.ts.map +1 -0
  20. package/dist/contracts/cli/index.js +7 -0
  21. package/dist/contracts/cli/index.js.map +1 -0
  22. package/dist/contracts/cli/metadata.d.ts +32 -0
  23. package/dist/contracts/cli/metadata.d.ts.map +1 -0
  24. package/dist/contracts/cli/metadata.js +2 -0
  25. package/dist/contracts/cli/metadata.js.map +1 -0
  26. package/dist/contracts/cli/operations.d.ts +2 -0
  27. package/dist/contracts/cli/operations.d.ts.map +1 -0
  28. package/dist/contracts/cli/operations.js +2 -0
  29. package/dist/contracts/cli/operations.js.map +1 -0
  30. package/dist/domain/comments/anchors.d.ts +2 -0
  31. package/dist/domain/comments/anchors.d.ts.map +1 -0
  32. package/dist/domain/comments/anchors.js +2 -0
  33. package/dist/domain/comments/anchors.js.map +1 -0
  34. package/dist/domain/comments/index.d.ts +5 -0
  35. package/dist/domain/comments/index.d.ts.map +1 -0
  36. package/dist/domain/comments/index.js +5 -0
  37. package/dist/domain/comments/index.js.map +1 -0
  38. package/dist/domain/comments/parser.d.ts +136 -0
  39. package/dist/domain/comments/parser.d.ts.map +1 -0
  40. package/dist/domain/comments/parser.js +920 -0
  41. package/dist/domain/comments/parser.js.map +1 -0
  42. package/dist/domain/comments/serializer.d.ts +2 -0
  43. package/dist/domain/comments/serializer.d.ts.map +1 -0
  44. package/dist/domain/comments/serializer.js +2 -0
  45. package/dist/domain/comments/serializer.js.map +1 -0
  46. package/dist/domain/comments/thread-key.d.ts +3 -0
  47. package/dist/domain/comments/thread-key.d.ts.map +1 -0
  48. package/dist/domain/comments/thread-key.js +22 -0
  49. package/dist/domain/comments/thread-key.js.map +1 -0
  50. package/dist/domain/frontmatter/index.d.ts +4 -0
  51. package/dist/domain/frontmatter/index.d.ts.map +1 -0
  52. package/dist/domain/frontmatter/index.js +4 -0
  53. package/dist/domain/frontmatter/index.js.map +1 -0
  54. package/dist/domain/frontmatter/parser.d.ts +13 -0
  55. package/dist/domain/frontmatter/parser.d.ts.map +1 -0
  56. package/dist/domain/frontmatter/parser.js +35 -0
  57. package/dist/domain/frontmatter/parser.js.map +1 -0
  58. package/dist/domain/frontmatter/serializer.d.ts +4 -0
  59. package/dist/domain/frontmatter/serializer.d.ts.map +1 -0
  60. package/dist/domain/frontmatter/serializer.js +33 -0
  61. package/dist/domain/frontmatter/serializer.js.map +1 -0
  62. package/dist/domain/frontmatter/validators.d.ts +6 -0
  63. package/dist/domain/frontmatter/validators.d.ts.map +1 -0
  64. package/dist/domain/frontmatter/validators.js +66 -0
  65. package/dist/domain/frontmatter/validators.js.map +1 -0
  66. package/dist/domain/images/index.d.ts +3 -0
  67. package/dist/domain/images/index.d.ts.map +1 -0
  68. package/dist/domain/images/index.js +3 -0
  69. package/dist/domain/images/index.js.map +1 -0
  70. package/dist/domain/images/rewrite.d.ts +17 -0
  71. package/dist/domain/images/rewrite.d.ts.map +1 -0
  72. package/dist/domain/images/rewrite.js +387 -0
  73. package/dist/domain/images/rewrite.js.map +1 -0
  74. package/dist/domain/images/style.d.ts +27 -0
  75. package/dist/domain/images/style.d.ts.map +1 -0
  76. package/dist/domain/images/style.js +186 -0
  77. package/dist/domain/images/style.js.map +1 -0
  78. package/dist/domain/project/index.d.ts +3 -0
  79. package/dist/domain/project/index.d.ts.map +1 -0
  80. package/dist/domain/project/index.js +5 -0
  81. package/dist/domain/project/index.js.map +1 -0
  82. package/dist/domain/stages/index.d.ts +5 -0
  83. package/dist/domain/stages/index.d.ts.map +1 -0
  84. package/dist/domain/stages/index.js +21 -0
  85. package/dist/domain/stages/index.js.map +1 -0
  86. package/dist/index.d.ts +8 -0
  87. package/dist/index.d.ts.map +1 -0
  88. package/dist/index.js +8 -0
  89. package/dist/index.js.map +1 -0
  90. package/dist/utils/guards.d.ts +3 -0
  91. package/dist/utils/guards.d.ts.map +1 -0
  92. package/dist/utils/guards.js +7 -0
  93. package/dist/utils/guards.js.map +1 -0
  94. package/dist/utils/index.d.ts +4 -0
  95. package/dist/utils/index.d.ts.map +1 -0
  96. package/dist/utils/index.js +4 -0
  97. package/dist/utils/index.js.map +1 -0
  98. package/dist/utils/invariant.d.ts +2 -0
  99. package/dist/utils/invariant.d.ts.map +1 -0
  100. package/dist/utils/invariant.js +6 -0
  101. package/dist/utils/invariant.js.map +1 -0
  102. package/dist/utils/result.d.ts +10 -0
  103. package/dist/utils/result.d.ts.map +1 -0
  104. package/dist/utils/result.js +7 -0
  105. package/dist/utils/result.js.map +1 -0
  106. package/package.json +84 -0
@@ -0,0 +1,5 @@
1
+ export type StageName = "draft" | "revise" | "line-edit" | "proof" | "final";
2
+ export declare const DEFAULT_ALLOWED_STATUSES: StageName[];
3
+ export declare function isStageName(value: string): value is StageName;
4
+ export declare function getStageRank(stage: StageName): number;
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/domain/stages/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,OAAO,GAAG,OAAO,CAAC;AAE7E,eAAO,MAAM,wBAAwB,EAAE,SAAS,EAM/C,CAAC;AAUF,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,SAAS,CAE7D;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,CAErD"}
@@ -0,0 +1,21 @@
1
+ export const DEFAULT_ALLOWED_STATUSES = [
2
+ "draft",
3
+ "revise",
4
+ "line-edit",
5
+ "proof",
6
+ "final"
7
+ ];
8
+ const STAGE_RANK = {
9
+ draft: 0,
10
+ revise: 1,
11
+ "line-edit": 2,
12
+ proof: 3,
13
+ final: 4
14
+ };
15
+ export function isStageName(value) {
16
+ return Object.hasOwn(STAGE_RANK, value);
17
+ }
18
+ export function getStageRank(stage) {
19
+ return STAGE_RANK[stage];
20
+ }
21
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/domain/stages/index.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,wBAAwB,GAAgB;IACnD,OAAO;IACP,QAAQ;IACR,WAAW;IACX,OAAO;IACP,OAAO;CACR,CAAC;AAEF,MAAM,UAAU,GAA8B;IAC5C,KAAK,EAAE,CAAC;IACR,MAAM,EAAE,CAAC;IACT,WAAW,EAAE,CAAC;IACd,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;CACT,CAAC;AAEF,MAAM,UAAU,WAAW,CAAC,KAAa;IACvC,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAgB;IAC3C,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;AAC3B,CAAC"}
@@ -0,0 +1,8 @@
1
+ export * as CliContracts from "./contracts/cli/index.ts";
2
+ export * as FrontmatterDomain from "./domain/frontmatter/index.ts";
3
+ export * as CommentsDomain from "./domain/comments/index.ts";
4
+ export * as StagesDomain from "./domain/stages/index.ts";
5
+ export * as ProjectDomain from "./domain/project/index.ts";
6
+ export * as ImagesDomain from "./domain/images/index.ts";
7
+ export * as SharedUtils from "./utils/index.ts";
8
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,iBAAiB,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,aAAa,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,8 @@
1
+ export * as CliContracts from "./contracts/cli/index.js";
2
+ export * as FrontmatterDomain from "./domain/frontmatter/index.js";
3
+ export * as CommentsDomain from "./domain/comments/index.js";
4
+ export * as StagesDomain from "./domain/stages/index.js";
5
+ export * as ProjectDomain from "./domain/project/index.js";
6
+ export * as ImagesDomain from "./domain/images/index.js";
7
+ export * as SharedUtils from "./utils/index.js";
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,iBAAiB,MAAM,+BAA+B,CAAC;AACnE,OAAO,KAAK,cAAc,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,aAAa,MAAM,2BAA2B,CAAC;AAC3D,OAAO,KAAK,YAAY,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC"}
@@ -0,0 +1,3 @@
1
+ export declare function isPlainObject(value: unknown): value is Record<string, unknown>;
2
+ export declare function isNonEmptyString(value: unknown): value is string;
3
+ //# sourceMappingURL=guards.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"guards.d.ts","sourceRoot":"","sources":["../../src/utils/guards.ts"],"names":[],"mappings":"AAAA,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAE9E;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAEhE"}
@@ -0,0 +1,7 @@
1
+ export function isPlainObject(value) {
2
+ return typeof value === "object" && value !== null && !Array.isArray(value);
3
+ }
4
+ export function isNonEmptyString(value) {
5
+ return typeof value === "string" && value.trim().length > 0;
6
+ }
7
+ //# sourceMappingURL=guards.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/utils/guards.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9D,CAAC"}
@@ -0,0 +1,4 @@
1
+ export * from "./result.ts";
2
+ export * from "./guards.ts";
3
+ export * from "./invariant.ts";
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}
@@ -0,0 +1,4 @@
1
+ export * from "./result.js";
2
+ export * from "./guards.js";
3
+ export * from "./invariant.js";
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC"}
@@ -0,0 +1,2 @@
1
+ export declare function invariant(condition: unknown, message: string): asserts condition;
2
+ //# sourceMappingURL=invariant.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../../src/utils/invariant.ts"],"names":[],"mappings":"AAAA,wBAAgB,SAAS,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAIhF"}
@@ -0,0 +1,6 @@
1
+ export function invariant(condition, message) {
2
+ if (!condition) {
3
+ throw new Error(message);
4
+ }
5
+ }
6
+ //# sourceMappingURL=invariant.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"invariant.js","sourceRoot":"","sources":["../../src/utils/invariant.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,SAAS,CAAC,SAAkB,EAAE,OAAe;IAC3D,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC"}
@@ -0,0 +1,10 @@
1
+ export type Result<TOk, TErr> = {
2
+ ok: true;
3
+ value: TOk;
4
+ } | {
5
+ ok: false;
6
+ error: TErr;
7
+ };
8
+ export declare function ok<TOk>(value: TOk): Result<TOk, never>;
9
+ export declare function err<TErr>(error: TErr): Result<never, TErr>;
10
+ //# sourceMappingURL=result.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../../src/utils/result.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,CAAC,GAAG,EAAE,IAAI,IACxB;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,GAAG,CAAA;CAAE,GACxB;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,IAAI,CAAA;CAAE,CAAC;AAE/B,wBAAgB,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAEtD;AAED,wBAAgB,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAE1D"}
@@ -0,0 +1,7 @@
1
+ export function ok(value) {
2
+ return { ok: true, value };
3
+ }
4
+ export function err(error) {
5
+ return { ok: false, error };
6
+ }
7
+ //# sourceMappingURL=result.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"result.js","sourceRoot":"","sources":["../../src/utils/result.ts"],"names":[],"mappings":"AAIA,MAAM,UAAU,EAAE,CAAM,KAAU;IAChC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,GAAG,CAAO,KAAW;IACnC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC9B,CAAC"}
package/package.json ADDED
@@ -0,0 +1,84 @@
1
+ {
2
+ "name": "@stego-labs/shared",
3
+ "version": "1.0.1",
4
+ "type": "module",
5
+ "description": "Shared contracts and domain primitives for Stego packages.",
6
+ "license": "Apache-2.0",
7
+ "types": "./dist/index.d.ts",
8
+ "repository": {
9
+ "type": "git",
10
+ "url": "https://github.com/matt-gold/stego.git",
11
+ "directory": "packages/shared"
12
+ },
13
+ "homepage": "https://github.com/matt-gold/stego/tree/main/packages/shared#readme",
14
+ "files": [
15
+ "dist/**",
16
+ "README.md"
17
+ ],
18
+ "exports": {
19
+ ".": {
20
+ "types": "./dist/index.d.ts",
21
+ "default": "./dist/index.js"
22
+ },
23
+ "./contracts/cli": {
24
+ "types": "./dist/contracts/cli/index.d.ts",
25
+ "default": "./dist/contracts/cli/index.js"
26
+ },
27
+ "./domain/comments": {
28
+ "types": "./dist/domain/comments/index.d.ts",
29
+ "default": "./dist/domain/comments/index.js"
30
+ },
31
+ "./domain/frontmatter": {
32
+ "types": "./dist/domain/frontmatter/index.d.ts",
33
+ "default": "./dist/domain/frontmatter/index.js"
34
+ },
35
+ "./domain/images": {
36
+ "types": "./dist/domain/images/index.d.ts",
37
+ "default": "./dist/domain/images/index.js"
38
+ },
39
+ "./domain/project": {
40
+ "types": "./dist/domain/project/index.d.ts",
41
+ "default": "./dist/domain/project/index.js"
42
+ },
43
+ "./domain/stages": {
44
+ "types": "./dist/domain/stages/index.d.ts",
45
+ "default": "./dist/domain/stages/index.js"
46
+ },
47
+ "./utils": {
48
+ "types": "./dist/utils/index.d.ts",
49
+ "default": "./dist/utils/index.js"
50
+ }
51
+ },
52
+ "typesVersions": {
53
+ "*": {
54
+ "contracts/cli": [
55
+ "dist/contracts/cli/index.d.ts"
56
+ ],
57
+ "domain/comments": [
58
+ "dist/domain/comments/index.d.ts"
59
+ ],
60
+ "domain/frontmatter": [
61
+ "dist/domain/frontmatter/index.d.ts"
62
+ ],
63
+ "domain/images": [
64
+ "dist/domain/images/index.d.ts"
65
+ ],
66
+ "domain/project": [
67
+ "dist/domain/project/index.d.ts"
68
+ ],
69
+ "domain/stages": [
70
+ "dist/domain/stages/index.d.ts"
71
+ ],
72
+ "utils": [
73
+ "dist/utils/index.d.ts"
74
+ ]
75
+ }
76
+ },
77
+ "scripts": {
78
+ "clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
79
+ "build": "npm run clean && tsc -p tsconfig.build.json",
80
+ "compile": "npm run build",
81
+ "prepack": "npm run build",
82
+ "pack:dry-run": "npm pack --dry-run"
83
+ }
84
+ }