json/api-contract.json at main · async/json · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
{
  "format": "api-contract.package.v1",
  "packageName": "@async/json",
  "catalogs": [
    {
      "format": "api-contract.catalog.v1",
      "contractId": "@async/json.package",
      "title": "Async JSON Package Exports",
      "features": [
        {
          "id": "export.root",
          "title": "@async/json opens JSON file/folder databases and exports stable JSON and file helpers",
          "releaseTag": "public",
          "stability": "stable",
          "group": "exports",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "export.redis",
          "title": "@async/json/redis provides an optional Redis JSON store adapter",
          "releaseTag": "beta",
          "stability": "preview",
          "group": "exports",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        }
      ]
    },
    {
      "format": "api-contract.catalog.v1",
      "contractId": "@async/json.runtime",
      "title": "Async JSON Runtime",
      "features": [
        {
          "id": "runtime.file-folder",
          "title": "JSON file and folder paths open as collection/document resources with sidecar state by default",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.resource-proxy",
          "title": "Folder database handles expose resources as properties with callable control collision handling",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.folder-recursive",
          "title": "Folder databases opened with recursive discover nested folders as path-named resources",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.folder-create",
          "title": "Folder databases opened with create grow sidecar-backed resources for unknown collection/document names",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.query",
          "title": "Collection query helpers support where, orderBy, limit, offset, count, and aggregate",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.local-engine",
          "title": "Local JSON engine owns atomic writes, sidecar state, version history, recovery, advisory locks, and declared indexes",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.identity",
          "title": "Collections support scalar idField identity and compound object-key identity without encoded fake ids",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.append-only",
          "title": "Append-only collections allow append writes and block create, update, delete, and replace-all mutations",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.encoded-payloads",
          "title": "Bytes field metadata validates base64, base64url, and hex JSON-safe payload strings",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.redis-json",
          "title": "Redis JSON adapter stores collection records under per-record canonical identity keys and creates only declared search indexes",
          "releaseTag": "beta",
          "stability": "preview",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.stable-json",
          "title": "Stable JSON helpers provide deterministic stringify, JSON5-compatible parse, ref-aware revivers, and an opt-in JSON shim",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        },
        {
          "id": "runtime.file-helpers",
          "title": "File helper namespace patches JSON files atomically while preserving existing object key order",
          "releaseTag": "public",
          "stability": "stable",
          "group": "runtime",
          "docsUrl": "https://github.com/async/json/blob/main/README.md"
        }
      ]
    }
  ],
  "supported": [
    {
      "format": "api-contract.surface.v1",
      "contractId": "@async/json.package",
      "features": [
        "export.root",
        "export.redis"
      ]
    },
    {
      "format": "api-contract.surface.v1",
      "contractId": "@async/json.runtime",
      "features": [
        "runtime.file-folder",
        "runtime.append-only",
        "runtime.encoded-payloads",
        "runtime.identity",
        "runtime.file-helpers",
        "runtime.local-engine",
        "runtime.resource-proxy",
        "runtime.query",
        "runtime.redis-json",
        "runtime.stable-json"
      ]
    }
  ]
}