@coasys/ad4m 0.12.0-rc1-dev → 0.12.0-rc1-dev.2

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 (128) hide show
  1. package/jest.config.js +4 -4
  2. package/lib/index.cjs +5999 -6044
  3. package/lib/index.js +5977 -6038
  4. package/lib/src/Ad4mClient.d.ts +16 -9
  5. package/lib/src/Ad4mClient.js +25 -46
  6. package/lib/src/Ad4mClient.test.d.ts +1 -0
  7. package/lib/src/Ad4mClient.test.js +1204 -0
  8. package/lib/src/Literal.d.ts +2 -1
  9. package/lib/src/Literal.js +35 -38
  10. package/lib/src/Literal.test.d.ts +1 -0
  11. package/lib/src/Literal.test.js +41 -0
  12. package/lib/src/SmartLiteral.d.ts +2 -1
  13. package/lib/src/SmartLiteral.js +15 -30
  14. package/lib/src/agent/AgentClient.d.ts +4 -1
  15. package/lib/src/agent/AgentClient.js +99 -79
  16. package/lib/src/ai/AIClient.d.ts +2 -1
  17. package/lib/src/ai/AIClient.js +220 -224
  18. package/lib/src/expression/ExpressionClient.d.ts +1 -1
  19. package/lib/src/expression/ExpressionClient.js +86 -73
  20. package/lib/src/index.d.ts +1 -1
  21. package/lib/src/index.js +1 -1
  22. package/lib/src/language/LanguageClient.d.ts +1 -1
  23. package/lib/src/language/LanguageClient.js +52 -52
  24. package/lib/src/model/Ad4mModel.d.ts +157 -937
  25. package/lib/src/model/Ad4mModel.js +212 -2797
  26. package/lib/src/model/Ad4mModel.test.js +1002 -561
  27. package/lib/src/model/decorators.d.ts +94 -426
  28. package/lib/src/model/decorators.js +333 -741
  29. package/lib/src/model/mutation.d.ts +81 -0
  30. package/lib/src/model/mutation.js +317 -0
  31. package/lib/src/model/parentUtils.d.ts +32 -0
  32. package/lib/src/model/parentUtils.js +64 -0
  33. package/lib/src/model/prolog/generatePrologFacts.d.ts +36 -0
  34. package/lib/src/model/prolog/generatePrologFacts.js +139 -0
  35. package/lib/src/model/prolog/index.d.ts +1 -0
  36. package/lib/src/model/prolog/index.js +1 -0
  37. package/lib/src/model/query/ModelQueryBuilder.d.ts +82 -0
  38. package/lib/src/model/query/ModelQueryBuilder.js +115 -0
  39. package/lib/src/model/query/QueryBuilder.d.ts +101 -0
  40. package/lib/src/model/query/QueryBuilder.js +193 -0
  41. package/lib/src/model/query/SurrealQueryBuilder.d.ts +48 -0
  42. package/lib/src/model/query/SurrealQueryBuilder.js +371 -0
  43. package/lib/src/model/query/fetchInstance.d.ts +24 -0
  44. package/lib/src/model/query/fetchInstance.js +144 -0
  45. package/lib/src/model/query/hydration.d.ts +54 -0
  46. package/lib/src/model/query/hydration.js +214 -0
  47. package/lib/src/model/query/operations.d.ts +59 -0
  48. package/lib/src/model/query/operations.js +384 -0
  49. package/lib/src/model/query/snapshot.d.ts +59 -0
  50. package/lib/src/model/query/snapshot.js +106 -0
  51. package/lib/src/model/query/surrealCompiler.d.ts +42 -0
  52. package/lib/src/model/query/surrealCompiler.js +304 -0
  53. package/lib/src/model/schema/fromJSONSchema.d.ts +67 -0
  54. package/lib/src/model/schema/fromJSONSchema.js +264 -0
  55. package/lib/src/model/schema/metadata.d.ts +15 -0
  56. package/lib/src/model/schema/metadata.js +112 -0
  57. package/lib/src/model/subscription.d.ts +47 -0
  58. package/lib/src/model/subscription.js +231 -0
  59. package/lib/src/model/transaction.d.ts +27 -0
  60. package/lib/src/model/transaction.js +32 -0
  61. package/lib/src/model/types.d.ts +195 -0
  62. package/lib/src/model/types.js +8 -0
  63. package/lib/src/model/util.js +7 -7
  64. package/lib/src/neighbourhood/NeighbourhoodClient.d.ts +5 -1
  65. package/lib/src/neighbourhood/NeighbourhoodClient.js +263 -181
  66. package/lib/src/neighbourhood/NeighbourhoodProxy.d.ts +2 -1
  67. package/lib/src/neighbourhood/NeighbourhoodProxy.js +13 -28
  68. package/lib/src/neighbourhood/NeighbourhoodProxy.test.js +1 -5
  69. package/lib/src/perspectives/PerspectiveClient.d.ts +9 -9
  70. package/lib/src/perspectives/PerspectiveClient.js +316 -240
  71. package/lib/src/perspectives/PerspectiveProxy.d.ts +54 -92
  72. package/lib/src/perspectives/PerspectiveProxy.js +803 -444
  73. package/lib/src/runtime/RuntimeClient.d.ts +5 -1
  74. package/lib/src/runtime/RuntimeClient.js +412 -238
  75. package/lib/src/shacl/SHACLFlow.test.js +164 -105
  76. package/lib/src/shacl/SHACLShape.d.ts +17 -3
  77. package/lib/src/shacl/SHACLShape.js +127 -90
  78. package/lib/src/shacl/SHACLShape.test.js +244 -176
  79. package/lib/src/utils.d.ts +8 -0
  80. package/lib/src/utils.js +21 -7
  81. package/package.json +8 -13
  82. package/src/Ad4mClient.test.ts +1564 -1315
  83. package/src/Ad4mClient.ts +55 -54
  84. package/src/Literal.test.ts +45 -26
  85. package/src/Literal.ts +82 -66
  86. package/src/SmartLiteral.ts +74 -58
  87. package/src/agent/AgentClient.ts +144 -99
  88. package/src/ai/AIClient.ts +409 -359
  89. package/src/expression/ExpressionClient.ts +142 -96
  90. package/src/index.ts +1 -1
  91. package/src/language/LanguageClient.ts +137 -113
  92. package/src/model/Ad4mModel.test.ts +1128 -647
  93. package/src/model/Ad4mModel.ts +485 -3247
  94. package/src/model/IMPROVEMENTS.md +482 -0
  95. package/src/model/PREDICATE_COLLISION_FIX.md +651 -0
  96. package/src/model/README.md +317 -0
  97. package/src/model/SHACL_MUTATION_DECOUPLING.md +356 -0
  98. package/src/model/SUBSCRIPTION_STRATEGY.md +317 -0
  99. package/src/model/TC39_STAGE_3_DECORATORS.md +609 -0
  100. package/src/model/decorators.ts +689 -1046
  101. package/src/model/mutation.ts +461 -0
  102. package/src/model/parentUtils.ts +91 -0
  103. package/src/model/prolog/generatePrologFacts.ts +176 -0
  104. package/src/model/prolog/index.ts +1 -0
  105. package/src/model/query/ModelQueryBuilder.ts +173 -0
  106. package/src/model/query/fetchInstance.ts +181 -0
  107. package/src/model/query/hydration.ts +273 -0
  108. package/src/model/query/operations.ts +510 -0
  109. package/src/model/query/snapshot.ts +126 -0
  110. package/src/model/query/surrealCompiler.ts +376 -0
  111. package/src/model/schema/fromJSONSchema.ts +411 -0
  112. package/src/model/schema/metadata.ts +148 -0
  113. package/src/model/subscription.ts +307 -0
  114. package/src/model/transaction.ts +60 -0
  115. package/src/model/types.ts +207 -0
  116. package/src/model/util.ts +47 -48
  117. package/src/neighbourhood/NeighbourhoodClient.ts +393 -251
  118. package/src/neighbourhood/NeighbourhoodProxy.test.ts +3 -7
  119. package/src/neighbourhood/NeighbourhoodProxy.ts +58 -40
  120. package/src/perspectives/PerspectiveClient.ts +779 -540
  121. package/src/perspectives/PerspectiveProxy.ts +2860 -2053
  122. package/src/runtime/RuntimeClient.ts +775 -476
  123. package/src/shacl/SHACLFlow.test.ts +196 -129
  124. package/src/shacl/SHACLShape.test.ts +284 -190
  125. package/src/shacl/SHACLShape.ts +225 -172
  126. package/src/utils.ts +31 -17
  127. package/tsconfig.json +9 -10
  128. package/src/model/Subject.ts +0 -159
@@ -1,5 +1,6 @@
1
1
  export declare class Literal {
2
- #private;
2
+ private _literal?;
3
+ private _url?;
3
4
  static fromUrl(url: string): Literal;
4
5
  static from(literal: any): Literal;
5
6
  toUrl(): string;
@@ -1,67 +1,57 @@
1
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
- if (kind === "m") throw new TypeError("Private method is not writable");
3
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
5
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
- };
7
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
10
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
- };
12
- var _Literal_literal, _Literal_url;
13
1
  function encodeRFC3986URIComponent(str) {
14
- return encodeURIComponent(str)
15
- .replace(/[!'()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`);
2
+ return encodeURIComponent(str).replace(/[!'()*]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase()}`);
16
3
  }
17
4
  export class Literal {
18
- constructor() {
19
- _Literal_literal.set(this, void 0);
20
- _Literal_url.set(this, void 0);
21
- }
22
5
  static fromUrl(url) {
23
6
  if (!url || !url.startsWith("literal://"))
24
7
  throw new Error("Can't create Literal from non-literal URL");
25
8
  const l = new Literal();
26
- __classPrivateFieldSet(l, _Literal_url, url, "f");
9
+ l._url = url;
27
10
  return l;
28
11
  }
29
12
  static from(literal) {
30
13
  const l = new Literal();
31
- __classPrivateFieldSet(l, _Literal_literal, literal, "f");
14
+ l._literal = literal;
32
15
  return l;
33
16
  }
34
17
  toUrl() {
35
- if (__classPrivateFieldGet(this, _Literal_url, "f") && !__classPrivateFieldGet(this, _Literal_literal, "f"))
36
- return __classPrivateFieldGet(this, _Literal_url, "f");
37
- if (!__classPrivateFieldGet(this, _Literal_url, "f") && (__classPrivateFieldGet(this, _Literal_literal, "f") === undefined || __classPrivateFieldGet(this, _Literal_literal, "f") === "" || __classPrivateFieldGet(this, _Literal_literal, "f") === null))
18
+ if (this._url && !this._literal)
19
+ return this._url;
20
+ if (!this._url &&
21
+ (this._literal === undefined ||
22
+ this._literal === "" ||
23
+ this._literal === null))
38
24
  throw new Error("Can't turn empty Literal into URL");
39
25
  let encoded;
40
- switch (typeof __classPrivateFieldGet(this, _Literal_literal, "f")) {
41
- case 'string':
42
- encoded = `string:${encodeRFC3986URIComponent(__classPrivateFieldGet(this, _Literal_literal, "f"))}`;
26
+ switch (typeof this._literal) {
27
+ case "string":
28
+ encoded = `string:${encodeRFC3986URIComponent(this._literal)}`;
43
29
  break;
44
- case 'number':
45
- encoded = `number:${encodeRFC3986URIComponent(__classPrivateFieldGet(this, _Literal_literal, "f"))}`;
30
+ case "number":
31
+ encoded = `number:${encodeRFC3986URIComponent(this._literal)}`;
46
32
  break;
47
- case 'boolean':
48
- encoded = `boolean:${encodeRFC3986URIComponent(__classPrivateFieldGet(this, _Literal_literal, "f"))}`;
33
+ case "boolean":
34
+ encoded = `boolean:${encodeRFC3986URIComponent(this._literal)}`;
49
35
  break;
50
- case 'object':
51
- encoded = `json:${encodeRFC3986URIComponent(JSON.stringify(__classPrivateFieldGet(this, _Literal_literal, "f")))}`;
36
+ case "object":
37
+ encoded = `json:${encodeRFC3986URIComponent(JSON.stringify(this._literal))}`;
52
38
  break;
39
+ default:
40
+ throw new Error(`Literal.toUrl(): unsupported type "${typeof this._literal}" (value: ${String(this._literal)})`);
53
41
  }
54
42
  return `literal://${encoded}`;
55
43
  }
56
44
  get() {
57
- if (__classPrivateFieldGet(this, _Literal_literal, "f"))
58
- return __classPrivateFieldGet(this, _Literal_literal, "f");
59
- if (!__classPrivateFieldGet(this, _Literal_url, "f"))
45
+ if (this._literal !== undefined &&
46
+ this._literal !== null &&
47
+ this._literal !== "")
48
+ return this._literal;
49
+ if (!this._url)
60
50
  throw new Error("Can't render empty Literal");
61
- if (!__classPrivateFieldGet(this, _Literal_url, "f").startsWith("literal://"))
51
+ if (!this._url.startsWith("literal://"))
62
52
  throw new Error("Can't render Literal from non-literal URL");
63
53
  // get rid of "literal://"
64
- const body = __classPrivateFieldGet(this, _Literal_url, "f").substring(10);
54
+ const body = this._url.substring(10);
65
55
  if (body.startsWith("string:")) {
66
56
  return decodeURIComponent(body.substring(7));
67
57
  }
@@ -69,6 +59,14 @@ export class Literal {
69
59
  const numberString = body.substring(7);
70
60
  return parseFloat(numberString);
71
61
  }
62
+ if (body.startsWith("boolean:")) {
63
+ const boolStr = body.substring(8).trim();
64
+ if (boolStr === "true")
65
+ return true;
66
+ if (boolStr === "false")
67
+ return false;
68
+ throw new Error(`Literal.get(): malformed boolean payload "${boolStr}" — expected "true" or "false"`);
69
+ }
72
70
  if (body.startsWith("json:")) {
73
71
  const json = body.substring(5);
74
72
  return JSON.parse(decodeURIComponent(json));
@@ -76,4 +74,3 @@ export class Literal {
76
74
  throw new Error(`Can't parse unknown literal: ${body}`);
77
75
  }
78
76
  }
79
- _Literal_literal = new WeakMap(), _Literal_url = new WeakMap();
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,41 @@
1
+ import { Literal } from "./Literal";
2
+ describe("Literal", () => {
3
+ it("can handle strings", () => {
4
+ const testString = "test string";
5
+ const testUrl = "literal://string:test%20string";
6
+ expect(Literal.from(testString).toUrl()).toBe(testUrl);
7
+ expect(Literal.fromUrl(testUrl).get()).toBe(testString);
8
+ });
9
+ it("can handle numbers", () => {
10
+ const testNumber = 3.1415;
11
+ const testUrl = "literal://number:3.1415";
12
+ expect(Literal.from(testNumber).toUrl()).toBe(testUrl);
13
+ expect(Literal.fromUrl(testUrl).get()).toBe(testNumber);
14
+ });
15
+ it("can handle objects", () => {
16
+ const testObject = { testNumber: "1337", testString: "test" };
17
+ const testUrl = "literal://json:%7B%22testNumber%22%3A%221337%22%2C%22testString%22%3A%22test%22%7D";
18
+ expect(Literal.from(testObject).toUrl()).toBe(testUrl);
19
+ expect(Literal.fromUrl(testUrl).get()).toStrictEqual(testObject);
20
+ });
21
+ it("can handle special characters", () => {
22
+ const testString = "message(X) :- triple('ad4m://self', _, X).";
23
+ const testUrl = "literal://string:message%28X%29%20%3A-%20triple%28%27ad4m%3A%2F%2Fself%27%2C%20_%2C%20X%29.";
24
+ expect(Literal.from(testString).toUrl()).toBe(testUrl);
25
+ expect(Literal.fromUrl(testUrl).get()).toBe(testString);
26
+ });
27
+ it("can handle boolean true", () => {
28
+ const testUrl = "literal://boolean:true";
29
+ expect(Literal.from(true).toUrl()).toBe(testUrl);
30
+ expect(Literal.fromUrl(testUrl).get()).toBe(true);
31
+ });
32
+ it("can handle boolean false", () => {
33
+ const testUrl = "literal://boolean:false";
34
+ expect(Literal.from(false).toUrl()).toBe(testUrl);
35
+ expect(Literal.fromUrl(testUrl).get()).toBe(false);
36
+ });
37
+ it("can handle zero", () => {
38
+ expect(Literal.from(0).toUrl()).toBe("literal://number:0");
39
+ expect(Literal.fromUrl("literal://number:0").get()).toBe(0);
40
+ });
41
+ });
@@ -1,7 +1,8 @@
1
1
  import { PerspectiveProxy } from "./perspectives/PerspectiveProxy";
2
2
  export declare const SMART_LITERAL_CONTENT_PREDICATE = "smart_literal://content";
3
3
  export declare class SmartLiteral {
4
- #private;
4
+ private _perspective;
5
+ private _base;
5
6
  constructor(perspective: PerspectiveProxy, base: string);
6
7
  get base(): string;
7
8
  static create(perspective: PerspectiveProxy, literal: any): Promise<SmartLiteral>;
@@ -1,22 +1,10 @@
1
- var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
2
- if (kind === "m") throw new TypeError("Private method is not writable");
3
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
4
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
5
- return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
6
- };
7
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
8
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
9
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
10
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
- };
12
- var _SmartLiteral_perspective, _SmartLiteral_base;
13
1
  import { Link } from "./links/Links";
14
2
  import { Literal } from "./Literal";
15
3
  import { LinkQuery } from "./perspectives/LinkQuery";
16
4
  export const SMART_LITERAL_CONTENT_PREDICATE = "smart_literal://content";
17
5
  function makeRandomStringID(length) {
18
- let result = '';
19
- let characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
6
+ let result = "";
7
+ let characters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
20
8
  let charactersLength = characters.length;
21
9
  for (let i = 0; i < length; i++) {
22
10
  result += characters.charAt(Math.floor(Math.random() * charactersLength));
@@ -25,13 +13,11 @@ function makeRandomStringID(length) {
25
13
  }
26
14
  export class SmartLiteral {
27
15
  constructor(perspective, base) {
28
- _SmartLiteral_perspective.set(this, void 0);
29
- _SmartLiteral_base.set(this, void 0);
30
- __classPrivateFieldSet(this, _SmartLiteral_perspective, perspective, "f");
31
- __classPrivateFieldSet(this, _SmartLiteral_base, base, "f");
16
+ this._perspective = perspective;
17
+ this._base = base;
32
18
  }
33
19
  get base() {
34
- return __classPrivateFieldGet(this, _SmartLiteral_base, "f");
20
+ return this._base;
35
21
  }
36
22
  static async create(perspective, literal) {
37
23
  const base = Literal.from(makeRandomStringID(10)).toUrl();
@@ -42,33 +28,32 @@ export class SmartLiteral {
42
28
  static async isSmartLiteralBase(perspective, base) {
43
29
  let links = await perspective.get(new LinkQuery({
44
30
  source: base,
45
- predicate: SMART_LITERAL_CONTENT_PREDICATE
31
+ predicate: SMART_LITERAL_CONTENT_PREDICATE,
46
32
  }));
47
33
  return links.length > 0;
48
34
  }
49
35
  static async getAllSmartLiterals(perspective) {
50
36
  let links = await perspective.get(new LinkQuery({
51
- predicate: SMART_LITERAL_CONTENT_PREDICATE
37
+ predicate: SMART_LITERAL_CONTENT_PREDICATE,
52
38
  }));
53
- return links.map(link => new SmartLiteral(perspective, link.data.source));
39
+ return links.map((link) => new SmartLiteral(perspective, link.data.source));
54
40
  }
55
41
  async get() {
56
- let link = await __classPrivateFieldGet(this, _SmartLiteral_perspective, "f").getSingleTarget(new LinkQuery({
57
- source: __classPrivateFieldGet(this, _SmartLiteral_base, "f"),
58
- predicate: SMART_LITERAL_CONTENT_PREDICATE
42
+ let link = await this._perspective.getSingleTarget(new LinkQuery({
43
+ source: this._base,
44
+ predicate: SMART_LITERAL_CONTENT_PREDICATE,
59
45
  }));
60
46
  if (!link) {
61
- throw `No content for smart literal ${__classPrivateFieldGet(this, _SmartLiteral_base, "f")}`;
47
+ throw `No content for smart literal ${this._base}`;
62
48
  }
63
49
  return Literal.fromUrl(link).get();
64
50
  }
65
51
  async set(content) {
66
52
  let literal = Literal.from(content);
67
- await __classPrivateFieldGet(this, _SmartLiteral_perspective, "f").setSingleTarget(new Link({
68
- source: __classPrivateFieldGet(this, _SmartLiteral_base, "f"),
53
+ await this._perspective.setSingleTarget(new Link({
54
+ source: this._base,
69
55
  predicate: SMART_LITERAL_CONTENT_PREDICATE,
70
- target: literal.toUrl()
56
+ target: literal.toUrl(),
71
57
  }));
72
58
  }
73
59
  }
74
- _SmartLiteral_perspective = new WeakMap(), _SmartLiteral_base = new WeakMap();
@@ -19,7 +19,10 @@ export type AgentAppsUpdatedCallback = () => null;
19
19
  * as well as updating the publicly shared Agent expression.
20
20
  */
21
21
  export declare class AgentClient {
22
- #private;
22
+ private _apolloClient;
23
+ private _appsChangedCallback;
24
+ private _updatedCallbacks;
25
+ private _agentStatusChangedCallbacks;
23
26
  constructor(client: ApolloClient<any>, subscribe?: boolean);
24
27
  /**
25
28
  * Returns the Agent expression of the local agent as it is shared