@panneau/protocol 5.0.0-alpha.27 → 5.0.0-alpha.29

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 (58) hide show
  1. package/dist/conformance/index.d.ts.map +1 -1
  2. package/dist/conformance/index.js +30 -4
  3. package/dist/conformance/index.js.map +1 -1
  4. package/dist/index.js +3 -2
  5. package/dist/lint.d.ts +1 -1
  6. package/dist/lint.d.ts.map +1 -1
  7. package/dist/lint.js +57 -8
  8. package/dist/lint.js.map +1 -1
  9. package/dist/mock/example.d.ts.map +1 -1
  10. package/dist/mock/example.js +39 -22
  11. package/dist/mock/example.js.map +1 -1
  12. package/dist/mock/index.d.ts +3 -1
  13. package/dist/mock/index.d.ts.map +1 -1
  14. package/dist/mock/index.js +46 -14
  15. package/dist/mock/index.js.map +1 -1
  16. package/dist/resourceTypes.d.ts +39 -0
  17. package/dist/resourceTypes.d.ts.map +1 -0
  18. package/dist/resourceTypes.js +34 -0
  19. package/dist/resourceTypes.js.map +1 -0
  20. package/dist/rules.d.ts +2 -1
  21. package/dist/rules.d.ts.map +1 -1
  22. package/dist/rules.js +3 -2
  23. package/dist/rules.js.map +1 -1
  24. package/dist/runtime/index.d.ts +1 -0
  25. package/dist/runtime/index.d.ts.map +1 -1
  26. package/dist/runtime/index.js +2 -1
  27. package/dist/schemas/action.d.ts +2 -0
  28. package/dist/schemas/action.d.ts.map +1 -1
  29. package/dist/schemas/api.d.ts +6 -0
  30. package/dist/schemas/api.d.ts.map +1 -1
  31. package/dist/schemas/api.js +2 -1
  32. package/dist/schemas/api.js.map +1 -1
  33. package/dist/schemas/definition.d.ts +10 -0
  34. package/dist/schemas/definition.d.ts.map +1 -1
  35. package/dist/schemas/field.d.ts +1 -0
  36. package/dist/schemas/field.d.ts.map +1 -1
  37. package/dist/schemas/field.js +1 -0
  38. package/dist/schemas/field.js.map +1 -1
  39. package/dist/schemas/index.d.ts +38 -0
  40. package/dist/schemas/index.d.ts.map +1 -1
  41. package/dist/schemas/index.js +3 -2
  42. package/dist/schemas/index.js.map +1 -1
  43. package/dist/schemas/layout.d.ts +1 -0
  44. package/dist/schemas/layout.d.ts.map +1 -1
  45. package/dist/schemas/layout.js +2 -1
  46. package/dist/schemas/layout.js.map +1 -1
  47. package/dist/schemas/resource.d.ts +18 -3
  48. package/dist/schemas/resource.d.ts.map +1 -1
  49. package/dist/schemas/resource.js +13 -3
  50. package/dist/schemas/resource.js.map +1 -1
  51. package/dist/schemas/theme.d.ts +4 -0
  52. package/dist/schemas/theme.d.ts.map +1 -1
  53. package/dist/schemas/theme.js +1 -0
  54. package/dist/schemas/theme.js.map +1 -1
  55. package/package.json +1 -1
  56. package/schema/boot.schema.json +48 -1
  57. package/schema/definition.schema.json +48 -1
  58. package/schema/openapi.json +69 -3
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/conformance/index.ts"],"names":[],"mappings":"AAgCA,MAAM,WAAW,kBAAkB;IAC/B,sFAAsF;IACtF,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,wEAAwE;IACxE,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE;QACL,mCAAmC;QACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,kCAAkC;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,2FAA2F;QAC3F,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACrC,CAAC;CACL;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEhE,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,CAAC;IAC1B,qDAAqD;IACrD,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAsFD;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAqoD5F;AAED,oDAAoD;AACpD,wBAAgB,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAU9D"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/conformance/index.ts"],"names":[],"mappings":"AAgCA,MAAM,WAAW,kBAAkB;IAC/B,sFAAsF;IACtF,OAAO,EAAE,MAAM,CAAC;IAChB,sDAAsD;IACtD,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,wEAAwE;IACxE,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE;QACL,mCAAmC;QACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,kCAAkC;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAChC,2FAA2F;QAC3F,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACrC,CAAC;CACL;AAED,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEhE,MAAM,WAAW,gBAAgB;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,iBAAiB,CAAC;IAC1B,qDAAqD;IACrD,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC9B;AAsFD;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CA2rD5F;AAED,oDAAoD;AACpD,wBAAgB,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAU9D"}
@@ -784,7 +784,7 @@ async function runConformance(options) {
784
784
  return;
785
785
  }
786
786
  const cases = resource.fields.flatMap((field) => {
787
- if (field.localized === true || field.readOnly === true) return [];
787
+ if (field.localized === true || field.readOnly === true || field.notInForm === true) return [];
788
788
  if (field.type === "daterange") {
789
789
  const time = field.settings?.time === true;
790
790
  return [[
@@ -864,7 +864,7 @@ async function runConformance(options) {
864
864
  check.skip("No item was created.");
865
865
  return;
866
866
  }
867
- const names = resource.fields.filter((field) => field.readOnly !== true && field.createOnly !== true && (field.rules ?? []).some((rule) => rule.rule === "required" && rule.mode === "create")).map((field) => field.name);
867
+ const names = resource.fields.filter((field) => field.readOnly !== true && field.notInForm !== true && field.createOnly !== true && (field.rules ?? []).some((rule) => rule.rule === "required" && rule.mode === "create")).map((field) => field.name);
868
868
  if (names.length === 0) {
869
869
  check.skip("The resource has no rule limited to create.");
870
870
  return;
@@ -881,7 +881,7 @@ async function runConformance(options) {
881
881
  check.skip("No item was created.");
882
882
  return;
883
883
  }
884
- const editable = resource.fields.filter((field) => field.readOnly !== true && field.createOnly !== true && field.localized !== true && field.abilities?.update !== false && field.visibleWhen === void 0);
884
+ const editable = resource.fields.filter((field) => field.readOnly !== true && field.notInForm !== true && field.createOnly !== true && field.localized !== true && field.abilities?.update !== false && field.visibleWhen === void 0);
885
885
  const address = editable.find((field) => {
886
886
  const countries = field.settings?.countries;
887
887
  return field.type === "address" && (!Array.isArray(countries) || countries.includes("CA") || countries.includes("US"));
@@ -956,10 +956,36 @@ async function runConformance(options) {
956
956
  const after = check.expectSchema(ItemResponse, reply.body, "The updated item");
957
957
  if (after === null) return;
958
958
  if (version !== null) check.expect(after.data.version !== version, "The version did not change after an update of a single field.");
959
- const changed = resource.fields.filter((field) => field.name !== name && field.readOnly !== true && field.settings?.secret !== true && !isEqual(before.data[field.name], after.data[field.name])).map((field) => field.name);
959
+ const changed = resource.fields.filter((field) => field.name !== name && field.readOnly !== true && field.notInForm !== true && field.settings?.secret !== true && !isEqual(before.data[field.name], after.data[field.name])).map((field) => field.name);
960
960
  check.expect(changed.length === 0, `An update of ${name} alone also changed ${changed.join(", ")}.`);
961
961
  updatedVersion = after.data.version;
962
962
  });
963
+ await run("update.not-in-form", "An update ignores the values of the fields that forms leave out", async (check) => {
964
+ if (createdId === null || writes === void 0 || resource === null) {
965
+ check.skip("No item was created.");
966
+ return;
967
+ }
968
+ const names = resource.fields.filter((field) => field.notInForm === true && field.abilities?.view !== false).map((field) => field.name);
969
+ if (names.length === 0) {
970
+ check.skip("The resource has no field with `notInForm`.");
971
+ return;
972
+ }
973
+ const current = await request(itemPath());
974
+ const before = check.expectStatus(current, 200) ? check.expectSchema(ItemResponse, current.body, "The item") : null;
975
+ if (before === null) return;
976
+ const version = before.data.version;
977
+ const reply = await request(itemPath(), {
978
+ method: "PATCH",
979
+ body: JSON.stringify(Object.fromEntries(names.map((name) => [name, "__panneau_conformance__"]))),
980
+ headers: version !== null ? { "If-Match": `"${version}"` } : {}
981
+ });
982
+ if (!check.expectStatus(reply, 200)) return;
983
+ const after = check.expectSchema(ItemResponse, reply.body, "The updated item");
984
+ if (after === null) return;
985
+ const changed = names.filter((name) => !isEqual(before.data[name], after.data[name]));
986
+ check.expect(changed.length === 0, `An update changed ${changed.join(", ")}, which forms leave out.`);
987
+ updatedVersion = after.data.version;
988
+ });
963
989
  await run("update.conflict", "A stale If-Match is a 412 problem with the current item", async (check) => {
964
990
  if (createdId === null || writes === void 0) {
965
991
  check.skip("No item was created.");