@fougere/schema 0.1.0-alpha.0

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 (171) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +32 -0
  3. package/dist/entity.d.ts +117 -0
  4. package/dist/entity.d.ts.map +1 -0
  5. package/dist/entity.js +285 -0
  6. package/dist/entity.js.map +1 -0
  7. package/dist/field/boundary.d.ts +75 -0
  8. package/dist/field/boundary.d.ts.map +1 -0
  9. package/dist/field/boundary.js +76 -0
  10. package/dist/field/boundary.js.map +1 -0
  11. package/dist/field/field.d.ts +64 -0
  12. package/dist/field/field.d.ts.map +1 -0
  13. package/dist/field/field.js +28 -0
  14. package/dist/field/field.js.map +1 -0
  15. package/dist/field/index.d.ts +7 -0
  16. package/dist/field/index.d.ts.map +1 -0
  17. package/dist/field/index.js +9 -0
  18. package/dist/field/index.js.map +1 -0
  19. package/dist/field/lifecycle.d.ts +40 -0
  20. package/dist/field/lifecycle.d.ts.map +1 -0
  21. package/dist/field/lifecycle.js +27 -0
  22. package/dist/field/lifecycle.js.map +1 -0
  23. package/dist/field/meta.d.ts +9 -0
  24. package/dist/field/meta.d.ts.map +1 -0
  25. package/dist/field/meta.js +7 -0
  26. package/dist/field/meta.js.map +1 -0
  27. package/dist/field/role.d.ts +54 -0
  28. package/dist/field/role.d.ts.map +1 -0
  29. package/dist/field/role.js +55 -0
  30. package/dist/field/role.js.map +1 -0
  31. package/dist/field/shape.d.ts +77 -0
  32. package/dist/field/shape.d.ts.map +1 -0
  33. package/dist/field/shape.js +49 -0
  34. package/dist/field/shape.js.map +1 -0
  35. package/dist/hints.d.ts +33 -0
  36. package/dist/hints.d.ts.map +1 -0
  37. package/dist/hints.js +2 -0
  38. package/dist/hints.js.map +1 -0
  39. package/dist/index.d.ts +36 -0
  40. package/dist/index.d.ts.map +1 -0
  41. package/dist/index.js +46 -0
  42. package/dist/index.js.map +1 -0
  43. package/dist/projections/card.d.ts +117 -0
  44. package/dist/projections/card.d.ts.map +1 -0
  45. package/dist/projections/card.js +8 -0
  46. package/dist/projections/card.js.map +1 -0
  47. package/dist/projections/describe.d.ts +25 -0
  48. package/dist/projections/describe.d.ts.map +1 -0
  49. package/dist/projections/describe.js +129 -0
  50. package/dist/projections/describe.js.map +1 -0
  51. package/dist/projections/encode.d.ts +11 -0
  52. package/dist/projections/encode.d.ts.map +1 -0
  53. package/dist/projections/encode.js +26 -0
  54. package/dist/projections/encode.js.map +1 -0
  55. package/dist/projections/io.d.ts +30 -0
  56. package/dist/projections/io.d.ts.map +1 -0
  57. package/dist/projections/io.js +52 -0
  58. package/dist/projections/io.js.map +1 -0
  59. package/dist/projections/lifecycle.d.ts +43 -0
  60. package/dist/projections/lifecycle.d.ts.map +1 -0
  61. package/dist/projections/lifecycle.js +115 -0
  62. package/dist/projections/lifecycle.js.map +1 -0
  63. package/dist/projections/reconstruct.d.ts +36 -0
  64. package/dist/projections/reconstruct.d.ts.map +1 -0
  65. package/dist/projections/reconstruct.js +149 -0
  66. package/dist/projections/reconstruct.js.map +1 -0
  67. package/dist/projections/source.d.ts +41 -0
  68. package/dist/projections/source.d.ts.map +1 -0
  69. package/dist/projections/source.js +37 -0
  70. package/dist/projections/source.js.map +1 -0
  71. package/dist/projections/standard.d.ts +41 -0
  72. package/dist/projections/standard.d.ts.map +1 -0
  73. package/dist/projections/standard.js +10 -0
  74. package/dist/projections/standard.js.map +1 -0
  75. package/dist/projections/typescript.d.ts +53 -0
  76. package/dist/projections/typescript.d.ts.map +1 -0
  77. package/dist/projections/typescript.js +166 -0
  78. package/dist/projections/typescript.js.map +1 -0
  79. package/dist/projections/validation.d.ts +49 -0
  80. package/dist/projections/validation.d.ts.map +1 -0
  81. package/dist/projections/validation.js +140 -0
  82. package/dist/projections/validation.js.map +1 -0
  83. package/dist/unique.d.ts +65 -0
  84. package/dist/unique.d.ts.map +1 -0
  85. package/dist/unique.js +80 -0
  86. package/dist/unique.js.map +1 -0
  87. package/dist/vocabulary/auto.d.ts +8 -0
  88. package/dist/vocabulary/auto.d.ts.map +1 -0
  89. package/dist/vocabulary/auto.js +13 -0
  90. package/dist/vocabulary/auto.js.map +1 -0
  91. package/dist/vocabulary/bool.d.ts +6 -0
  92. package/dist/vocabulary/bool.d.ts.map +1 -0
  93. package/dist/vocabulary/bool.js +9 -0
  94. package/dist/vocabulary/bool.js.map +1 -0
  95. package/dist/vocabulary/date.d.ts +3 -0
  96. package/dist/vocabulary/date.d.ts.map +1 -0
  97. package/dist/vocabulary/date.js +5 -0
  98. package/dist/vocabulary/date.js.map +1 -0
  99. package/dist/vocabulary/email.d.ts +5 -0
  100. package/dist/vocabulary/email.d.ts.map +1 -0
  101. package/dist/vocabulary/email.js +6 -0
  102. package/dist/vocabulary/email.js.map +1 -0
  103. package/dist/vocabulary/immutable.d.ts +9 -0
  104. package/dist/vocabulary/immutable.d.ts.map +1 -0
  105. package/dist/vocabulary/immutable.js +11 -0
  106. package/dist/vocabulary/immutable.js.map +1 -0
  107. package/dist/vocabulary/indexed.d.ts +19 -0
  108. package/dist/vocabulary/indexed.d.ts.map +1 -0
  109. package/dist/vocabulary/indexed.js +21 -0
  110. package/dist/vocabulary/indexed.js.map +1 -0
  111. package/dist/vocabulary/json.d.ts +18 -0
  112. package/dist/vocabulary/json.d.ts.map +1 -0
  113. package/dist/vocabulary/json.js +16 -0
  114. package/dist/vocabulary/json.js.map +1 -0
  115. package/dist/vocabulary/list.d.ts +21 -0
  116. package/dist/vocabulary/list.d.ts.map +1 -0
  117. package/dist/vocabulary/list.js +21 -0
  118. package/dist/vocabulary/list.js.map +1 -0
  119. package/dist/vocabulary/many.d.ts +8 -0
  120. package/dist/vocabulary/many.d.ts.map +1 -0
  121. package/dist/vocabulary/many.js +12 -0
  122. package/dist/vocabulary/many.js.map +1 -0
  123. package/dist/vocabulary/nullable.d.ts +9 -0
  124. package/dist/vocabulary/nullable.d.ts.map +1 -0
  125. package/dist/vocabulary/nullable.js +13 -0
  126. package/dist/vocabulary/nullable.js.map +1 -0
  127. package/dist/vocabulary/number.d.ts +10 -0
  128. package/dist/vocabulary/number.d.ts.map +1 -0
  129. package/dist/vocabulary/number.js +9 -0
  130. package/dist/vocabulary/number.js.map +1 -0
  131. package/dist/vocabulary/oneOf.d.ts +16 -0
  132. package/dist/vocabulary/oneOf.d.ts.map +1 -0
  133. package/dist/vocabulary/oneOf.js +13 -0
  134. package/dist/vocabulary/oneOf.js.map +1 -0
  135. package/dist/vocabulary/optional.d.ts +10 -0
  136. package/dist/vocabulary/optional.d.ts.map +1 -0
  137. package/dist/vocabulary/optional.js +15 -0
  138. package/dist/vocabulary/optional.js.map +1 -0
  139. package/dist/vocabulary/primary.d.ts +22 -0
  140. package/dist/vocabulary/primary.d.ts.map +1 -0
  141. package/dist/vocabulary/primary.js +31 -0
  142. package/dist/vocabulary/primary.js.map +1 -0
  143. package/dist/vocabulary/readOnly.d.ts +10 -0
  144. package/dist/vocabulary/readOnly.d.ts.map +1 -0
  145. package/dist/vocabulary/readOnly.js +12 -0
  146. package/dist/vocabulary/readOnly.js.map +1 -0
  147. package/dist/vocabulary/ref.d.ts +12 -0
  148. package/dist/vocabulary/ref.d.ts.map +1 -0
  149. package/dist/vocabulary/ref.js +20 -0
  150. package/dist/vocabulary/ref.js.map +1 -0
  151. package/dist/vocabulary/text.d.ts +12 -0
  152. package/dist/vocabulary/text.d.ts.map +1 -0
  153. package/dist/vocabulary/text.js +9 -0
  154. package/dist/vocabulary/text.js.map +1 -0
  155. package/dist/vocabulary/unique.d.ts +23 -0
  156. package/dist/vocabulary/unique.d.ts.map +1 -0
  157. package/dist/vocabulary/unique.js +25 -0
  158. package/dist/vocabulary/unique.js.map +1 -0
  159. package/dist/vocabulary/updated.d.ts +8 -0
  160. package/dist/vocabulary/updated.d.ts.map +1 -0
  161. package/dist/vocabulary/updated.js +12 -0
  162. package/dist/vocabulary/updated.js.map +1 -0
  163. package/dist/vocabulary/url.d.ts +5 -0
  164. package/dist/vocabulary/url.d.ts.map +1 -0
  165. package/dist/vocabulary/url.js +6 -0
  166. package/dist/vocabulary/url.js.map +1 -0
  167. package/dist/vocabulary/writeOnly.d.ts +9 -0
  168. package/dist/vocabulary/writeOnly.d.ts.map +1 -0
  169. package/dist/vocabulary/writeOnly.js +11 -0
  170. package/dist/vocabulary/writeOnly.js.map +1 -0
  171. package/package.json +40 -0
@@ -0,0 +1,12 @@
1
+ import { auto } from './auto.js';
2
+ import { createField } from '../field/index.js';
3
+ /**
4
+ * `auto()`, plus the update stamp — the canonical `updatedAt` (Prisma
5
+ * `@updatedAt`, Kysely-side `$onUpdate` equivalents). The only new fact is `update: 'now'`;
6
+ * shape and creation rule are auto()'s, stated once there.
7
+ */
8
+ export function updated() {
9
+ const base = auto();
10
+ return createField({ ...base, lifecycle: { ...base.lifecycle, update: 'now' } });
11
+ }
12
+ //# sourceMappingURL=updated.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"updated.js","sourceRoot":"","sources":["../../src/vocabulary/updated.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAE5D;;;;GAIG;AACH,MAAM,UAAU,OAAO;IACrB,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC;IACpB,OAAO,WAAW,CAAa,EAAE,GAAG,IAAI,EAAE,SAAS,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;AAC/F,CAAC"}
@@ -0,0 +1,5 @@
1
+ import { type TextOptions } from './text.js';
2
+ import type { Field } from '../field/index.js';
3
+ /** A string holding a URL — `text({ format: 'uri' })` (JSON Schema's name), named. */
4
+ export declare function url(opts?: Omit<TextOptions, 'format'>): Field<string>;
5
+ //# sourceMappingURL=url.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../src/vocabulary/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,WAAW,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,sFAAsF;AACtF,wBAAgB,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAErE"}
@@ -0,0 +1,6 @@
1
+ import { text } from './text.js';
2
+ /** A string holding a URL — `text({ format: 'uri' })` (JSON Schema's name), named. */
3
+ export function url(opts) {
4
+ return text({ ...opts, format: 'uri' });
5
+ }
6
+ //# sourceMappingURL=url.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"url.js","sourceRoot":"","sources":["../../src/vocabulary/url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAoB,MAAM,WAAW,CAAC;AAGnD,sFAAsF;AACtF,MAAM,UAAU,GAAG,CAAC,IAAkC;IACpD,OAAO,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;AAC1C,CAAC"}
@@ -0,0 +1,9 @@
1
+ import { type Field } from '../field/index.js';
2
+ /**
3
+ * Close the field's OUTBOUND direction — accepted at create/patch, never
4
+ * emitted (the canonical password). `encodeFields` omits it and the adapters
5
+ * exclude it from their output types. The inbound direction (and its
6
+ * conversion) is untouched.
7
+ */
8
+ export declare function writeOnly<T, A extends boolean>(field: Field<T, A>): Field<T, A>;
9
+ //# sourceMappingURL=writeOnly.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"writeOnly.d.ts","sourceRoot":"","sources":["../../src/vocabulary/writeOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,KAAK,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE9E;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAE/E"}
@@ -0,0 +1,11 @@
1
+ import { createField, declaredBoundary } from '../field/index.js';
2
+ /**
3
+ * Close the field's OUTBOUND direction — accepted at create/patch, never
4
+ * emitted (the canonical password). `encodeFields` omits it and the adapters
5
+ * exclude it from their output types. The inbound direction (and its
6
+ * conversion) is untouched.
7
+ */
8
+ export function writeOnly(field) {
9
+ return createField({ ...field, boundary: { ...declaredBoundary(field), out: 'closed' } });
10
+ }
11
+ //# sourceMappingURL=writeOnly.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"writeOnly.js","sourceRoot":"","sources":["../../src/vocabulary/writeOnly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAc,MAAM,mBAAmB,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAuB,KAAkB;IAChE,OAAO,WAAW,CAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;AAClG,CAAC"}
package/package.json ADDED
@@ -0,0 +1,40 @@
1
+ {
2
+ "name": "@fougere/schema",
3
+ "version": "0.1.0-alpha.0",
4
+ "description": "The entity and its 4 axes — shape, role, lifecycle, boundary. No engine dependency.",
5
+ "license": "MIT",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/chok/fougere.git",
9
+ "directory": "packages/schema"
10
+ },
11
+ "type": "module",
12
+ "main": "dist/index.js",
13
+ "types": "dist/index.d.ts",
14
+ "exports": {
15
+ ".": {
16
+ "types": "./dist/index.d.ts",
17
+ "import": "./dist/index.js",
18
+ "default": "./dist/index.js"
19
+ }
20
+ },
21
+ "files": [
22
+ "dist"
23
+ ],
24
+ "dependencies": {
25
+ "@cfworker/json-schema": "^4.1.1",
26
+ "@paralleldrive/cuid2": "^3.3.0"
27
+ },
28
+ "devDependencies": {
29
+ "@types/json-schema": "^7.0.15"
30
+ },
31
+ "publishConfig": {
32
+ "access": "public"
33
+ },
34
+ "scripts": {
35
+ "build": "rm -rf dist && tsc",
36
+ "test": "vitest run",
37
+ "test:watch": "vitest",
38
+ "typecheck": "tsc --noEmit -p tsconfig.test.json"
39
+ }
40
+ }