@graphprotocol/grc-20 0.11.4 → 0.12.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.
- package/README.md +7 -48
- package/dist/convert-ids.d.ts +2 -0
- package/dist/convert-ids.d.ts.map +1 -0
- package/dist/convert-ids.js +42 -0
- package/dist/convert-ids.js.map +1 -0
- package/dist/index.d.ts +1 -25
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -25
- package/dist/index.js.map +1 -1
- package/dist/proto.d.ts +0 -4
- package/dist/proto.d.ts.map +1 -1
- package/dist/proto.js +0 -4
- package/dist/proto.js.map +1 -1
- package/dist/protov2.d.ts +11 -0
- package/dist/protov2.d.ts.map +1 -0
- package/dist/protov2.js +11 -0
- package/dist/protov2.js.map +1 -0
- package/dist/src/blocks.d.ts +0 -7
- package/dist/src/blocks.d.ts.map +1 -1
- package/dist/src/blocks.js +0 -7
- package/dist/src/blocks.js.map +1 -1
- package/dist/src/core/account.d.ts +2 -2
- package/dist/src/core/account.d.ts.map +1 -1
- package/dist/src/core/account.js +27 -38
- package/dist/src/core/account.js.map +1 -1
- package/dist/src/core/account.test.js +25 -17
- package/dist/src/core/account.test.js.map +1 -1
- package/dist/src/core/blocks/data.d.ts +2 -2
- package/dist/src/core/blocks/data.d.ts.map +1 -1
- package/dist/src/core/blocks/data.js +25 -24
- package/dist/src/core/blocks/data.js.map +1 -1
- package/dist/src/core/blocks/data.test.js +20 -20
- package/dist/src/core/blocks/data.test.js.map +1 -1
- package/dist/src/core/blocks/text.d.ts.map +1 -1
- package/dist/src/core/blocks/text.js +22 -22
- package/dist/src/core/blocks/text.js.map +1 -1
- package/dist/src/core/blocks/text.test.js +11 -11
- package/dist/src/core/blocks/text.test.js.map +1 -1
- package/dist/src/core/ids/content.d.ts +1 -37
- package/dist/src/core/ids/content.d.ts.map +1 -1
- package/dist/src/core/ids/content.js +55 -199
- package/dist/src/core/ids/content.js.map +1 -1
- package/dist/src/core/ids/network.d.ts.map +1 -1
- package/dist/src/core/ids/network.js +3 -3
- package/dist/src/core/ids/network.js.map +1 -1
- package/dist/src/core/ids/system.d.ts +6 -51
- package/dist/src/core/ids/system.d.ts.map +1 -1
- package/dist/src/core/ids/system.js +142 -310
- package/dist/src/core/ids/system.js.map +1 -1
- package/dist/src/core/idsv2/content.d.ts +59 -0
- package/dist/src/core/idsv2/content.d.ts.map +1 -0
- package/dist/src/core/idsv2/content.js +59 -0
- package/dist/src/core/idsv2/content.js.map +1 -0
- package/dist/src/core/idsv2/network.d.ts +5 -0
- package/dist/src/core/idsv2/network.d.ts.map +1 -0
- package/dist/src/core/idsv2/network.js +5 -0
- package/dist/src/core/idsv2/network.js.map +1 -0
- package/dist/src/core/idsv2/system.d.ts +222 -0
- package/dist/src/core/idsv2/system.d.ts.map +1 -0
- package/dist/src/core/idsv2/system.js +230 -0
- package/dist/src/core/idsv2/system.js.map +1 -0
- package/dist/src/core/scheme.d.ts +1 -1
- package/dist/src/core/scheme.d.ts.map +1 -1
- package/dist/src/graph/create-entity.d.ts +21 -18
- package/dist/src/graph/create-entity.d.ts.map +1 -1
- package/dist/src/graph/create-entity.js +96 -27
- package/dist/src/graph/create-entity.js.map +1 -1
- package/dist/src/graph/create-entity.test.js +101 -245
- package/dist/src/graph/create-entity.test.js.map +1 -1
- package/dist/src/graph/create-image.d.ts +1 -14
- package/dist/src/graph/create-image.d.ts.map +1 -1
- package/dist/src/graph/create-image.js +34 -7
- package/dist/src/graph/create-image.js.map +1 -1
- package/dist/src/graph/create-image.test.js +38 -47
- package/dist/src/graph/create-image.test.js.map +1 -1
- package/dist/src/graph/create-property.d.ts +1 -9
- package/dist/src/graph/create-property.d.ts.map +1 -1
- package/dist/src/graph/create-property.js +52 -36
- package/dist/src/graph/create-property.js.map +1 -1
- package/dist/src/graph/create-property.test.js +10 -12
- package/dist/src/graph/create-property.test.js.map +1 -1
- package/dist/src/graph/create-relation.d.ts +33 -0
- package/dist/src/graph/create-relation.d.ts.map +1 -0
- package/dist/src/graph/create-relation.js +66 -0
- package/dist/src/graph/create-relation.js.map +1 -0
- package/dist/src/graph/create-relation.test.d.ts +2 -0
- package/dist/src/graph/create-relation.test.d.ts.map +1 -0
- package/dist/src/graph/create-relation.test.js +208 -0
- package/dist/src/graph/create-relation.test.js.map +1 -0
- package/dist/src/graph/create-type.d.ts +3 -8
- package/dist/src/graph/create-type.d.ts.map +1 -1
- package/dist/src/graph/create-type.js +29 -17
- package/dist/src/graph/create-type.js.map +1 -1
- package/dist/src/graph/create-type.test.js +37 -35
- package/dist/src/graph/create-type.test.js.map +1 -1
- package/dist/src/graph/delete-entity.d.ts +4 -10
- package/dist/src/graph/delete-entity.d.ts.map +1 -1
- package/dist/src/graph/delete-entity.js +10 -35
- package/dist/src/graph/delete-entity.js.map +1 -1
- package/dist/src/graph/delete-entity.test.js +17 -35
- package/dist/src/graph/delete-entity.test.js.map +1 -1
- package/dist/src/graph/delete-relation.d.ts +14 -0
- package/dist/src/graph/delete-relation.d.ts.map +1 -0
- package/dist/src/graph/delete-relation.js +21 -0
- package/dist/src/graph/delete-relation.js.map +1 -0
- package/dist/src/graph/delete-relation.test.d.ts +2 -0
- package/dist/src/graph/delete-relation.test.d.ts.map +1 -0
- package/dist/src/graph/delete-relation.test.js +24 -0
- package/dist/src/graph/delete-relation.test.js.map +1 -0
- package/dist/src/graph/index.d.ts +5 -0
- package/dist/src/graph/index.d.ts.map +1 -1
- package/dist/src/graph/index.js +5 -0
- package/dist/src/graph/index.js.map +1 -1
- package/dist/src/graph/unset-entity-values.d.ts +21 -0
- package/dist/src/graph/unset-entity-values.d.ts.map +1 -0
- package/dist/src/graph/unset-entity-values.js +26 -0
- package/dist/src/graph/unset-entity-values.js.map +1 -0
- package/dist/src/graph/unset-entity-values.test.d.ts +2 -0
- package/dist/src/graph/unset-entity-values.test.d.ts.map +1 -0
- package/dist/src/graph/unset-entity-values.test.js +40 -0
- package/dist/src/graph/unset-entity-values.test.js.map +1 -0
- package/dist/src/graph/unset-relation-fields.d.ts +25 -0
- package/dist/src/graph/unset-relation-fields.d.ts.map +1 -0
- package/dist/src/graph/unset-relation-fields.js +34 -0
- package/dist/src/graph/unset-relation-fields.js.map +1 -0
- package/dist/src/graph/unset-relation-fields.test.d.ts +2 -0
- package/dist/src/graph/unset-relation-fields.test.d.ts.map +1 -0
- package/dist/src/graph/unset-relation-fields.test.js +64 -0
- package/dist/src/graph/unset-relation-fields.test.js.map +1 -0
- package/dist/src/graph/update-entity.d.ts +28 -0
- package/dist/src/graph/update-entity.d.ts.map +1 -0
- package/dist/src/graph/update-entity.js +73 -0
- package/dist/src/graph/update-entity.js.map +1 -0
- package/dist/src/graph/update-entity.test.d.ts +2 -0
- package/dist/src/graph/update-entity.test.d.ts.map +1 -0
- package/dist/src/graph/update-entity.test.js +116 -0
- package/dist/src/graph/update-entity.test.js.map +1 -0
- package/dist/src/graph/update-relation.d.ts +21 -0
- package/dist/src/graph/update-relation.d.ts.map +1 -0
- package/dist/src/graph/update-relation.js +37 -0
- package/dist/src/graph/update-relation.js.map +1 -0
- package/dist/src/graphv2/constants.d.ts +2 -0
- package/dist/src/graphv2/constants.d.ts.map +1 -0
- package/dist/src/graphv2/constants.js +2 -0
- package/dist/src/graphv2/constants.js.map +1 -0
- package/dist/src/graphv2/create-entity.d.ts +52 -0
- package/dist/src/graphv2/create-entity.d.ts.map +1 -0
- package/dist/src/graphv2/create-entity.js +140 -0
- package/dist/src/graphv2/create-entity.js.map +1 -0
- package/dist/src/graphv2/create-entity.test.d.ts +2 -0
- package/dist/src/graphv2/create-entity.test.d.ts.map +1 -0
- package/dist/src/graphv2/create-entity.test.js +158 -0
- package/dist/src/graphv2/create-entity.test.js.map +1 -0
- package/dist/src/graphv2/create-image.d.ts +28 -0
- package/dist/src/graphv2/create-image.d.ts.map +1 -0
- package/dist/src/graphv2/create-image.js +71 -0
- package/dist/src/graphv2/create-image.js.map +1 -0
- package/dist/src/graphv2/create-image.test.d.ts +2 -0
- package/dist/src/graphv2/create-image.test.d.ts.map +1 -0
- package/dist/src/graphv2/create-image.test.js +142 -0
- package/dist/src/graphv2/create-image.test.js.map +1 -0
- package/dist/src/graphv2/create-property.d.ts +22 -0
- package/dist/src/graphv2/create-property.d.ts.map +1 -0
- package/dist/src/graphv2/create-property.js +129 -0
- package/dist/src/graphv2/create-property.js.map +1 -0
- package/dist/src/graphv2/create-property.test.d.ts +2 -0
- package/dist/src/graphv2/create-property.test.d.ts.map +1 -0
- package/dist/src/graphv2/create-property.test.js +82 -0
- package/dist/src/graphv2/create-property.test.js.map +1 -0
- package/dist/src/graphv2/create-relation.d.ts +33 -0
- package/dist/src/graphv2/create-relation.d.ts.map +1 -0
- package/dist/src/graphv2/create-relation.js +66 -0
- package/dist/src/graphv2/create-relation.js.map +1 -0
- package/dist/src/graphv2/create-relation.test.d.ts +2 -0
- package/dist/src/graphv2/create-relation.test.d.ts.map +1 -0
- package/dist/src/graphv2/create-relation.test.js +208 -0
- package/dist/src/graphv2/create-relation.test.js.map +1 -0
- package/dist/src/graphv2/create-space.d.ts +13 -0
- package/dist/src/graphv2/create-space.d.ts.map +1 -0
- package/dist/src/graphv2/create-space.js +21 -0
- package/dist/src/graphv2/create-space.js.map +1 -0
- package/dist/src/graphv2/create-type.d.ts +22 -0
- package/dist/src/graphv2/create-type.d.ts.map +1 -0
- package/dist/src/graphv2/create-type.js +64 -0
- package/dist/src/graphv2/create-type.js.map +1 -0
- package/dist/src/graphv2/create-type.test.d.ts +2 -0
- package/dist/src/graphv2/create-type.test.d.ts.map +1 -0
- package/dist/src/graphv2/create-type.test.js +109 -0
- package/dist/src/graphv2/create-type.test.js.map +1 -0
- package/dist/src/graphv2/delete-entity.d.ts +14 -0
- package/dist/src/graphv2/delete-entity.d.ts.map +1 -0
- package/dist/src/graphv2/delete-entity.js +21 -0
- package/dist/src/graphv2/delete-entity.js.map +1 -0
- package/dist/src/graphv2/delete-entity.test.d.ts +2 -0
- package/dist/src/graphv2/delete-entity.test.d.ts.map +1 -0
- package/dist/src/graphv2/delete-entity.test.js +24 -0
- package/dist/src/graphv2/delete-entity.test.js.map +1 -0
- package/dist/src/graphv2/delete-relation.d.ts +14 -0
- package/dist/src/graphv2/delete-relation.d.ts.map +1 -0
- package/dist/src/graphv2/delete-relation.js +21 -0
- package/dist/src/graphv2/delete-relation.js.map +1 -0
- package/dist/src/graphv2/delete-relation.test.d.ts +2 -0
- package/dist/src/graphv2/delete-relation.test.d.ts.map +1 -0
- package/dist/src/graphv2/delete-relation.test.js +24 -0
- package/dist/src/graphv2/delete-relation.test.js.map +1 -0
- package/dist/src/graphv2/index.d.ts +12 -0
- package/dist/src/graphv2/index.d.ts.map +1 -0
- package/dist/src/graphv2/index.js +12 -0
- package/dist/src/graphv2/index.js.map +1 -0
- package/dist/src/graphv2/remove-entity-properties.d.ts +25 -0
- package/dist/src/graphv2/remove-entity-properties.d.ts.map +1 -0
- package/dist/src/graphv2/remove-entity-properties.js +24 -0
- package/dist/src/graphv2/remove-entity-properties.js.map +1 -0
- package/dist/src/graphv2/unset-entity-values.d.ts +21 -0
- package/dist/src/graphv2/unset-entity-values.d.ts.map +1 -0
- package/dist/src/graphv2/unset-entity-values.js +26 -0
- package/dist/src/graphv2/unset-entity-values.js.map +1 -0
- package/dist/src/graphv2/unset-entity-values.test.d.ts +2 -0
- package/dist/src/graphv2/unset-entity-values.test.d.ts.map +1 -0
- package/dist/src/graphv2/unset-entity-values.test.js +40 -0
- package/dist/src/graphv2/unset-entity-values.test.js.map +1 -0
- package/dist/src/graphv2/unset-relation-fields.d.ts +25 -0
- package/dist/src/graphv2/unset-relation-fields.d.ts.map +1 -0
- package/dist/src/graphv2/unset-relation-fields.js +34 -0
- package/dist/src/graphv2/unset-relation-fields.js.map +1 -0
- package/dist/src/graphv2/unset-relation-fields.test.d.ts +2 -0
- package/dist/src/graphv2/unset-relation-fields.test.d.ts.map +1 -0
- package/dist/src/graphv2/unset-relation-fields.test.js +64 -0
- package/dist/src/graphv2/unset-relation-fields.test.js.map +1 -0
- package/dist/src/graphv2/update-entity.d.ts +28 -0
- package/dist/src/graphv2/update-entity.d.ts.map +1 -0
- package/dist/src/graphv2/update-entity.js +73 -0
- package/dist/src/graphv2/update-entity.js.map +1 -0
- package/dist/src/graphv2/update-entity.test.d.ts +2 -0
- package/dist/src/graphv2/update-entity.test.d.ts.map +1 -0
- package/dist/src/graphv2/update-entity.test.js +116 -0
- package/dist/src/graphv2/update-entity.test.js.map +1 -0
- package/dist/src/graphv2/update-relation.d.ts +21 -0
- package/dist/src/graphv2/update-relation.d.ts.map +1 -0
- package/dist/src/graphv2/update-relation.js +37 -0
- package/dist/src/graphv2/update-relation.js.map +1 -0
- package/dist/src/id.d.ts +9 -2
- package/dist/src/id.d.ts.map +1 -1
- package/dist/src/id.js +55 -22
- package/dist/src/id.js.map +1 -1
- package/dist/src/id.test.js +13 -10
- package/dist/src/id.test.js.map +1 -1
- package/dist/src/idv2.d.ts +27 -0
- package/dist/src/idv2.d.ts.map +1 -0
- package/dist/src/idv2.js +88 -0
- package/dist/src/idv2.js.map +1 -0
- package/dist/src/idv2.test.d.ts +2 -0
- package/dist/src/idv2.test.d.ts.map +1 -0
- package/dist/src/idv2.test.js +26 -0
- package/dist/src/idv2.test.js.map +1 -0
- package/dist/src/ipfs.d.ts +2 -2
- package/dist/src/ipfs.d.ts.map +1 -1
- package/dist/src/ipfs.js +2 -2
- package/dist/src/ipfs.js.map +1 -1
- package/dist/src/ipfs.test.d.ts +2 -0
- package/dist/src/ipfs.test.d.ts.map +1 -0
- package/dist/src/ipfs.test.js +22 -0
- package/dist/src/ipfs.test.js.map +1 -0
- package/dist/src/ipfsv2.d.ts +96 -0
- package/dist/src/ipfsv2.d.ts.map +1 -0
- package/dist/src/ipfsv2.js +163 -0
- package/dist/src/ipfsv2.js.map +1 -0
- package/dist/src/ipfsv2.test.d.ts +2 -0
- package/dist/src/ipfsv2.test.d.ts.map +1 -0
- package/dist/src/ipfsv2.test.js +22 -0
- package/dist/src/ipfsv2.test.js.map +1 -0
- package/dist/src/proto/edit.d.ts +4 -2
- package/dist/src/proto/edit.d.ts.map +1 -1
- package/dist/src/proto/edit.js +53 -32
- package/dist/src/proto/edit.js.map +1 -1
- package/dist/src/proto/edit.test.js +139 -152
- package/dist/src/proto/edit.test.js.map +1 -1
- package/dist/src/proto/editv2.d.ts +11 -0
- package/dist/src/proto/editv2.d.ts.map +1 -0
- package/dist/src/proto/editv2.js +81 -0
- package/dist/src/proto/editv2.js.map +1 -0
- package/dist/src/proto/editv2.test.d.ts +2 -0
- package/dist/src/proto/editv2.test.d.ts.map +1 -0
- package/dist/src/proto/editv2.test.js +211 -0
- package/dist/src/proto/editv2.test.js.map +1 -0
- package/dist/src/proto/gen/src/proto/ipfs_pb.d.ts +249 -369
- package/dist/src/proto/gen/src/proto/ipfs_pb.d.ts.map +1 -1
- package/dist/src/proto/gen/src/proto/ipfs_pb.js +244 -484
- package/dist/src/proto/gen/src/proto/ipfs_pb.js.map +1 -1
- package/dist/src/proto/gen/src/proto/ipfsv2_pb.d.ts +410 -0
- package/dist/src/proto/gen/src/proto/ipfsv2_pb.d.ts.map +1 -0
- package/dist/src/proto/gen/src/proto/ipfsv2_pb.js +536 -0
- package/dist/src/proto/gen/src/proto/ipfsv2_pb.js.map +1 -0
- package/dist/src/smart-wallet-2.test-invalid.d.ts +2 -0
- package/dist/src/smart-wallet-2.test-invalid.d.ts.map +1 -0
- package/dist/src/smart-wallet-2.test-invalid.js +49 -0
- package/dist/src/smart-wallet-2.test-invalid.js.map +1 -0
- package/dist/src/smart-wallet-2.test.d.ts +2 -0
- package/dist/src/smart-wallet-2.test.d.ts.map +1 -0
- package/dist/src/smart-wallet-2.test.js +49 -0
- package/dist/src/smart-wallet-2.test.js.map +1 -0
- package/dist/src/system-ids-v2.d.ts +7 -0
- package/dist/src/system-ids-v2.d.ts.map +1 -0
- package/dist/src/system-ids-v2.js +7 -0
- package/dist/src/system-ids-v2.js.map +1 -0
- package/dist/src/system-ids.d.ts +0 -2
- package/dist/src/system-ids.d.ts.map +1 -1
- package/dist/src/system-ids.js +0 -2
- package/dist/src/system-ids.js.map +1 -1
- package/dist/src/types-backup.d.ts +134 -0
- package/dist/src/types-backup.d.ts.map +1 -0
- package/dist/src/types-backup.js +13 -0
- package/dist/src/types-backup.js.map +1 -0
- package/dist/src/types.d.ts +126 -103
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/types.js +0 -5
- package/dist/src/types.js.map +1 -1
- package/dist/src/typesv2.d.ts +173 -0
- package/dist/src/typesv2.d.ts.map +1 -0
- package/dist/src/typesv2.js +8 -0
- package/dist/src/typesv2.js.map +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { assertValid, toBase64 } from '../idv2.js';
|
|
2
|
+
/**
|
|
3
|
+
* Updates a relation.
|
|
4
|
+
*
|
|
5
|
+
* @example
|
|
6
|
+
* ```ts
|
|
7
|
+
* const { id, ops } = updateRelation({
|
|
8
|
+
* id: relationId,
|
|
9
|
+
* position: 'position of the relation',
|
|
10
|
+
* toSpace: 'id of the to space',
|
|
11
|
+
* fromVersion: 'id of the from version',
|
|
12
|
+
* toVersion: 'id of the to version',
|
|
13
|
+
* verified: true,
|
|
14
|
+
* });
|
|
15
|
+
* ```
|
|
16
|
+
* @param params – {@link UpdateRelationParams}
|
|
17
|
+
* @returns – {@link CreateResult}
|
|
18
|
+
* @throws Will throw an error if any provided ID is invalid
|
|
19
|
+
*/
|
|
20
|
+
export const updateRelation = ({ id, position, fromSpace, toSpace, fromVersion, toVersion, verified, }) => {
|
|
21
|
+
assertValid(id, '`id` in `updateRelation`');
|
|
22
|
+
const ops = [];
|
|
23
|
+
ops.push({
|
|
24
|
+
type: 'UPDATE_RELATION',
|
|
25
|
+
relation: {
|
|
26
|
+
id: toBase64(id),
|
|
27
|
+
position,
|
|
28
|
+
fromSpace: fromSpace ? toBase64(fromSpace) : undefined,
|
|
29
|
+
toSpace: toSpace ? toBase64(toSpace) : undefined,
|
|
30
|
+
fromVersion: fromVersion ? toBase64(fromVersion) : undefined,
|
|
31
|
+
toVersion: toVersion ? toBase64(toVersion) : undefined,
|
|
32
|
+
verified,
|
|
33
|
+
},
|
|
34
|
+
});
|
|
35
|
+
return { id, ops };
|
|
36
|
+
};
|
|
37
|
+
//# sourceMappingURL=update-relation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"update-relation.js","sourceRoot":"","sources":["../../../src/graphv2/update-relation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGnD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,EAC7B,EAAE,EACF,QAAQ,EACR,SAAS,EACT,OAAO,EACP,WAAW,EACX,SAAS,EACT,QAAQ,GACa,EAAgB,EAAE;IACvC,WAAW,CAAC,EAAE,EAAE,0BAA0B,CAAC,CAAC;IAE5C,MAAM,GAAG,GAAc,EAAE,CAAC;IAE1B,GAAG,CAAC,IAAI,CAAC;QACP,IAAI,EAAE,iBAAiB;QACvB,QAAQ,EAAE;YACR,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC;YAChB,QAAQ;YACR,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YACtD,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;YAChD,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;YAC5D,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;YACtD,QAAQ;SACT;KACF,CAAC,CAAC;IAEH,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;AACrB,CAAC,CAAC"}
|
package/dist/src/id.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { Brand } from 'effect';
|
|
2
2
|
export type Id = string & Brand.Brand<'Id'>;
|
|
3
|
+
export type IdBase64 = string & Brand.Brand<'IdBase64'>;
|
|
3
4
|
export declare const Id: Brand.Brand.Constructor<Id>;
|
|
5
|
+
export declare const IdBase64: Brand.Brand.Constructor<IdBase64>;
|
|
4
6
|
/**
|
|
5
7
|
* Generates a globally unique knowledge graph identifier.
|
|
6
8
|
*
|
|
@@ -9,12 +11,17 @@ export declare const Id: Brand.Brand.Constructor<Id>;
|
|
|
9
11
|
* import { ID } from '@graphprotocol/grc-20'
|
|
10
12
|
*
|
|
11
13
|
* const id = ID.generate();
|
|
12
|
-
* console.log(id)
|
|
14
|
+
* console.log(id)
|
|
13
15
|
* ```
|
|
14
16
|
*
|
|
15
|
-
* @returns
|
|
17
|
+
* @returns v4 UUID
|
|
16
18
|
*/
|
|
17
19
|
export declare function generate(): Id;
|
|
18
20
|
export declare function isValid(id: string): boolean;
|
|
21
|
+
export declare function isValidBase64(id: string): boolean;
|
|
19
22
|
export declare function assertValid(id: string, sourceHint?: string): void;
|
|
23
|
+
export declare function toBytes(id: Id): Uint8Array;
|
|
24
|
+
export declare function fromBytes(bytes: Uint8Array): Id;
|
|
25
|
+
export declare function toBase64(id: Id): IdBase64;
|
|
26
|
+
export declare function fromBase64(id: IdBase64): Id;
|
|
20
27
|
//# sourceMappingURL=id.d.ts.map
|
package/dist/src/id.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"id.d.ts","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"id.d.ts","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAS/B,MAAM,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAE5C,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAExD,eAAO,MAAM,EAAE,6BAGd,CAAC;AAEF,eAAO,MAAM,QAAQ,mCAGpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,IAAI,EAAE,CAG7B;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAE3C;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAQjD;AAED,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,QAI1D;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,EAAE,GAAG,UAAU,CAE1C;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,EAAE,CAE/C;AAID,wBAAgB,QAAQ,CAAC,EAAE,EAAE,EAAE,GAAG,QAAQ,CAoBzC;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,QAAQ,GAAG,EAAE,CAqB3C"}
|
package/dist/src/id.js
CHANGED
|
@@ -2,12 +2,10 @@ import { Brand } from 'effect';
|
|
|
2
2
|
/**
|
|
3
3
|
* This module provides utility functions for working knowledge graph
|
|
4
4
|
* identifiers in TypeScript.
|
|
5
|
-
*
|
|
6
|
-
* @since 0.0.6
|
|
7
5
|
*/
|
|
8
|
-
import { validate as uuidValidate, v4 as uuidv4 } from 'uuid';
|
|
9
|
-
import { decodeBase58ToUUID, encodeBase58 } from './core/base58.js';
|
|
6
|
+
import { parse as uuidParse, stringify as uuidStringify, validate as uuidValidate, v4 as uuidv4 } from 'uuid';
|
|
10
7
|
export const Id = Brand.refined(id => isValid(id), id => Brand.error(`Expected ${id} to be a valid Id`));
|
|
8
|
+
export const IdBase64 = Brand.refined(id => isValidBase64(id), id => Brand.error(`Expected ${id} to be a valid IdBase64`));
|
|
11
9
|
/**
|
|
12
10
|
* Generates a globally unique knowledge graph identifier.
|
|
13
11
|
*
|
|
@@ -16,32 +14,23 @@ export const Id = Brand.refined(id => isValid(id), id => Brand.error(`Expected $
|
|
|
16
14
|
* import { ID } from '@graphprotocol/grc-20'
|
|
17
15
|
*
|
|
18
16
|
* const id = ID.generate();
|
|
19
|
-
* console.log(id)
|
|
17
|
+
* console.log(id)
|
|
20
18
|
* ```
|
|
21
19
|
*
|
|
22
|
-
* @returns
|
|
20
|
+
* @returns v4 UUID
|
|
23
21
|
*/
|
|
24
22
|
export function generate() {
|
|
25
23
|
const uuid = uuidv4();
|
|
26
|
-
|
|
27
|
-
const rawId = encodeBase58(stripped);
|
|
28
|
-
// In extremely rare occasions the id generator may result in ids that are
|
|
29
|
-
// 21 characters instead of 22. Theoretically the smallest length the id can
|
|
30
|
-
// generate is 16 characters, but only in specifically engineered cases.
|
|
31
|
-
//
|
|
32
|
-
// If this occurs we can generate again until we get a valid id.
|
|
33
|
-
if (rawId.length === 22) {
|
|
34
|
-
return Id(rawId);
|
|
35
|
-
}
|
|
36
|
-
return generate();
|
|
24
|
+
return Id(uuid);
|
|
37
25
|
}
|
|
38
26
|
export function isValid(id) {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
27
|
+
return uuidValidate(id);
|
|
28
|
+
}
|
|
29
|
+
export function isValidBase64(id) {
|
|
42
30
|
try {
|
|
43
|
-
|
|
44
|
-
|
|
31
|
+
// @ts-expect-error
|
|
32
|
+
const uuid = fromBase64(id);
|
|
33
|
+
return isValid(uuid);
|
|
45
34
|
}
|
|
46
35
|
catch (error) {
|
|
47
36
|
return false;
|
|
@@ -52,4 +41,48 @@ export function assertValid(id, sourceHint) {
|
|
|
52
41
|
throw new Error(`Invalid id: "${id}"${sourceHint ? ` for ${sourceHint}` : ''}`);
|
|
53
42
|
}
|
|
54
43
|
}
|
|
44
|
+
export function toBytes(id) {
|
|
45
|
+
return uuidParse(id);
|
|
46
|
+
}
|
|
47
|
+
export function fromBytes(bytes) {
|
|
48
|
+
return Id(uuidStringify(bytes));
|
|
49
|
+
}
|
|
50
|
+
const base64Chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
|
|
51
|
+
export function toBase64(id) {
|
|
52
|
+
const bytes = toBytes(id);
|
|
53
|
+
let result = '';
|
|
54
|
+
let i;
|
|
55
|
+
for (i = 0; i < bytes.length; i += 3) {
|
|
56
|
+
const a = bytes[i];
|
|
57
|
+
const b = bytes[i + 1] ?? 0;
|
|
58
|
+
const c = bytes[i + 2] ?? 0;
|
|
59
|
+
// @ts-expect-error
|
|
60
|
+
const triple = (a << 16) | (b << 8) | c;
|
|
61
|
+
result += base64Chars[(triple >> 18) & 0x3f];
|
|
62
|
+
result += base64Chars[(triple >> 12) & 0x3f];
|
|
63
|
+
result += i + 1 < bytes.length ? base64Chars[(triple >> 6) & 0x3f] : '=';
|
|
64
|
+
result += i + 2 < bytes.length ? base64Chars[triple & 0x3f] : '=';
|
|
65
|
+
}
|
|
66
|
+
return IdBase64(result);
|
|
67
|
+
}
|
|
68
|
+
export function fromBase64(id) {
|
|
69
|
+
const bytes = [];
|
|
70
|
+
for (let i = 0; i < id.length; i += 4) {
|
|
71
|
+
// @ts-expect-error
|
|
72
|
+
const c1 = base64Chars.indexOf(id[i]);
|
|
73
|
+
// @ts-expect-error
|
|
74
|
+
const c2 = base64Chars.indexOf(id[i + 1]);
|
|
75
|
+
// @ts-expect-error
|
|
76
|
+
const c3 = base64Chars.indexOf(id[i + 2]);
|
|
77
|
+
// @ts-expect-error
|
|
78
|
+
const c4 = base64Chars.indexOf(id[i + 3]);
|
|
79
|
+
const triple = (c1 << 18) | (c2 << 12) | ((c3 & 63) << 6) | (c4 & 63);
|
|
80
|
+
bytes.push((triple >> 16) & 0xff);
|
|
81
|
+
if (c3 !== -1 && c3 !== 64)
|
|
82
|
+
bytes.push((triple >> 8) & 0xff);
|
|
83
|
+
if (c4 !== -1 && c4 !== 64)
|
|
84
|
+
bytes.push(triple & 0xff);
|
|
85
|
+
}
|
|
86
|
+
return fromBytes(new Uint8Array(bytes));
|
|
87
|
+
}
|
|
55
88
|
//# sourceMappingURL=id.js.map
|
package/dist/src/id.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"id.js","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B
|
|
1
|
+
{"version":3,"file":"id.js","sourceRoot":"","sources":["../../src/id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B;;;GAGG;AAEH,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,SAAS,IAAI,aAAa,EAAE,QAAQ,IAAI,YAAY,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAM9G,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAC7B,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EACjB,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,mBAAmB,CAAC,CACrD,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CACnC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,EACvB,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAC3D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ;IACtB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;IACtB,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAU;IAChC,OAAO,YAAY,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,EAAU;IACtC,IAAI,CAAC;QACH,mBAAmB;QACnB,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,EAAU,EAAE,UAAmB;IACzD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gBAAgB,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC,QAAQ,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAM;IAC5B,OAAO,SAAS,CAAC,EAAE,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,WAAW,GAAG,kEAAkE,CAAC;AAEvF,MAAM,UAAU,QAAQ,CAAC,EAAM;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC1B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,CAAS,CAAC;IAEd,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAE5B,mBAAmB;QACnB,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAExC,MAAM,IAAI,WAAW,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,IAAI,WAAW,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACpE,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,EAAY;IACrC,MAAM,KAAK,GAAG,EAAE,CAAC;IAEjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1C,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1C,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAEtE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAClC,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7D,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,SAAS,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AAC1C,CAAC"}
|
package/dist/src/id.test.js
CHANGED
|
@@ -1,23 +1,26 @@
|
|
|
1
1
|
import { expect, it } from 'vitest';
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
// @NOTE this would be a good candidate for DST-style tests
|
|
5
|
-
it('should generate valid base58 encoded id with length of 22', () => {
|
|
2
|
+
import { Id, generate, isValid, toBase64 } from './id.js';
|
|
3
|
+
it('should generate valid uuid', () => {
|
|
6
4
|
const id = generate();
|
|
7
5
|
expect(id).toBeTypeOf('string');
|
|
8
|
-
expect(id.length).toBe(
|
|
9
|
-
expect(id
|
|
6
|
+
expect(id.length).toBe(36);
|
|
7
|
+
expect(id).toMatch(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/);
|
|
10
8
|
});
|
|
11
|
-
it('should validate
|
|
9
|
+
it('should validate uuid', () => {
|
|
12
10
|
expect(isValid(generate())).toBe(true);
|
|
13
11
|
expect(isValid(generate())).toBe(true);
|
|
14
12
|
expect(isValid(generate())).toBe(true);
|
|
15
|
-
expect(isValid('
|
|
16
|
-
// length is 21
|
|
17
|
-
expect(isValid('D6Wy4bdtdoUrG3PDZceHr')).toBe(true);
|
|
13
|
+
expect(isValid('3af3e22d-2169-4a07-8681-516710b7ecf1')).toBe(true);
|
|
18
14
|
});
|
|
19
15
|
it('should not validate invalid id', () => {
|
|
20
16
|
expect(isValid('invalid-id')).toBe(false);
|
|
21
17
|
expect(isValid('0123456789012345678901')).toBe(false);
|
|
22
18
|
});
|
|
19
|
+
it('should convert id to base64', () => {
|
|
20
|
+
const id = Id('3af3e22d-2169-4a07-8681-516710b7ecf1');
|
|
21
|
+
const base64 = toBase64(id);
|
|
22
|
+
expect(base64).toBeTypeOf('string');
|
|
23
|
+
expect(base64).toBe('OvPiLSFpSgeGgVFnELfs8Q==');
|
|
24
|
+
expect(toBase64(Id('1d501a3a-d6ce-4693-bc90-d25286f21c7e'))).toBe('HVAaOtbORpO8kNJShvIcfg==');
|
|
25
|
+
});
|
|
23
26
|
//# sourceMappingURL=id.test.js.map
|
package/dist/src/id.test.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"id.test.js","sourceRoot":"","sources":["../../src/id.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"id.test.js","sourceRoot":"","sources":["../../src/id.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE1D,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACpC,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,+EAA+E,CAAC,CAAC;AACtG,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAC9B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;IACxC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;IACrC,MAAM,EAAE,GAAG,EAAE,CAAC,sCAAsC,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IAChD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,sCAAsC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;AAChG,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Brand } from 'effect';
|
|
2
|
+
export type Id = string & Brand.Brand<'Id'>;
|
|
3
|
+
export type IdBase64 = string & Brand.Brand<'IdBase64'>;
|
|
4
|
+
export declare const Id: Brand.Brand.Constructor<Id>;
|
|
5
|
+
export declare const IdBase64: Brand.Brand.Constructor<IdBase64>;
|
|
6
|
+
/**
|
|
7
|
+
* Generates a globally unique knowledge graph identifier.
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```
|
|
11
|
+
* import { ID } from '@graphprotocol/grc-20'
|
|
12
|
+
*
|
|
13
|
+
* const id = ID.generate();
|
|
14
|
+
* console.log(id)
|
|
15
|
+
* ```
|
|
16
|
+
*
|
|
17
|
+
* @returns v4 UUID
|
|
18
|
+
*/
|
|
19
|
+
export declare function generate(): Id;
|
|
20
|
+
export declare function isValid(id: string): boolean;
|
|
21
|
+
export declare function isValidBase64(id: string): boolean;
|
|
22
|
+
export declare function assertValid(id: string, sourceHint?: string): void;
|
|
23
|
+
export declare function toBytes(id: Id): Uint8Array;
|
|
24
|
+
export declare function fromBytes(bytes: Uint8Array): Id;
|
|
25
|
+
export declare function toBase64(id: Id): IdBase64;
|
|
26
|
+
export declare function fromBase64(id: IdBase64): Id;
|
|
27
|
+
//# sourceMappingURL=idv2.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"idv2.d.ts","sourceRoot":"","sources":["../../src/idv2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAS/B,MAAM,MAAM,EAAE,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAE5C,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAExD,eAAO,MAAM,EAAE,6BAGd,CAAC;AAEF,eAAO,MAAM,QAAQ,mCAGpB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,IAAI,EAAE,CAG7B;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAE3C;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAQjD;AAED,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,QAI1D;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,EAAE,GAAG,UAAU,CAE1C;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,EAAE,CAE/C;AAID,wBAAgB,QAAQ,CAAC,EAAE,EAAE,EAAE,GAAG,QAAQ,CAoBzC;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,QAAQ,GAAG,EAAE,CAqB3C"}
|
package/dist/src/idv2.js
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { Brand } from 'effect';
|
|
2
|
+
/**
|
|
3
|
+
* This module provides utility functions for working knowledge graph
|
|
4
|
+
* identifiers in TypeScript.
|
|
5
|
+
*/
|
|
6
|
+
import { parse as uuidParse, stringify as uuidStringify, validate as uuidValidate, v4 as uuidv4 } from 'uuid';
|
|
7
|
+
export const Id = Brand.refined(id => isValid(id), id => Brand.error(`Expected ${id} to be a valid Id`));
|
|
8
|
+
export const IdBase64 = Brand.refined(id => isValidBase64(id), id => Brand.error(`Expected ${id} to be a valid IdBase64`));
|
|
9
|
+
/**
|
|
10
|
+
* Generates a globally unique knowledge graph identifier.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```
|
|
14
|
+
* import { ID } from '@graphprotocol/grc-20'
|
|
15
|
+
*
|
|
16
|
+
* const id = ID.generate();
|
|
17
|
+
* console.log(id)
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* @returns v4 UUID
|
|
21
|
+
*/
|
|
22
|
+
export function generate() {
|
|
23
|
+
const uuid = uuidv4();
|
|
24
|
+
return Id(uuid);
|
|
25
|
+
}
|
|
26
|
+
export function isValid(id) {
|
|
27
|
+
return uuidValidate(id);
|
|
28
|
+
}
|
|
29
|
+
export function isValidBase64(id) {
|
|
30
|
+
try {
|
|
31
|
+
// @ts-expect-error
|
|
32
|
+
const uuid = fromBase64(id);
|
|
33
|
+
return isValid(uuid);
|
|
34
|
+
}
|
|
35
|
+
catch (error) {
|
|
36
|
+
return false;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
export function assertValid(id, sourceHint) {
|
|
40
|
+
if (!isValid(id)) {
|
|
41
|
+
throw new Error(`Invalid id: "${id}"${sourceHint ? ` for ${sourceHint}` : ''}`);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
export function toBytes(id) {
|
|
45
|
+
return uuidParse(id);
|
|
46
|
+
}
|
|
47
|
+
export function fromBytes(bytes) {
|
|
48
|
+
return Id(uuidStringify(bytes));
|
|
49
|
+
}
|
|
50
|
+
const base64Chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
|
|
51
|
+
export function toBase64(id) {
|
|
52
|
+
const bytes = toBytes(id);
|
|
53
|
+
let result = '';
|
|
54
|
+
let i;
|
|
55
|
+
for (i = 0; i < bytes.length; i += 3) {
|
|
56
|
+
const a = bytes[i];
|
|
57
|
+
const b = bytes[i + 1] ?? 0;
|
|
58
|
+
const c = bytes[i + 2] ?? 0;
|
|
59
|
+
// @ts-expect-error
|
|
60
|
+
const triple = (a << 16) | (b << 8) | c;
|
|
61
|
+
result += base64Chars[(triple >> 18) & 0x3f];
|
|
62
|
+
result += base64Chars[(triple >> 12) & 0x3f];
|
|
63
|
+
result += i + 1 < bytes.length ? base64Chars[(triple >> 6) & 0x3f] : '=';
|
|
64
|
+
result += i + 2 < bytes.length ? base64Chars[triple & 0x3f] : '=';
|
|
65
|
+
}
|
|
66
|
+
return IdBase64(result);
|
|
67
|
+
}
|
|
68
|
+
export function fromBase64(id) {
|
|
69
|
+
const bytes = [];
|
|
70
|
+
for (let i = 0; i < id.length; i += 4) {
|
|
71
|
+
// @ts-expect-error
|
|
72
|
+
const c1 = base64Chars.indexOf(id[i]);
|
|
73
|
+
// @ts-expect-error
|
|
74
|
+
const c2 = base64Chars.indexOf(id[i + 1]);
|
|
75
|
+
// @ts-expect-error
|
|
76
|
+
const c3 = base64Chars.indexOf(id[i + 2]);
|
|
77
|
+
// @ts-expect-error
|
|
78
|
+
const c4 = base64Chars.indexOf(id[i + 3]);
|
|
79
|
+
const triple = (c1 << 18) | (c2 << 12) | ((c3 & 63) << 6) | (c4 & 63);
|
|
80
|
+
bytes.push((triple >> 16) & 0xff);
|
|
81
|
+
if (c3 !== -1 && c3 !== 64)
|
|
82
|
+
bytes.push((triple >> 8) & 0xff);
|
|
83
|
+
if (c4 !== -1 && c4 !== 64)
|
|
84
|
+
bytes.push(triple & 0xff);
|
|
85
|
+
}
|
|
86
|
+
return fromBytes(new Uint8Array(bytes));
|
|
87
|
+
}
|
|
88
|
+
//# sourceMappingURL=idv2.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"idv2.js","sourceRoot":"","sources":["../../src/idv2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B;;;GAGG;AAEH,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,SAAS,IAAI,aAAa,EAAE,QAAQ,IAAI,YAAY,EAAE,EAAE,IAAI,MAAM,EAAE,MAAM,MAAM,CAAC;AAM9G,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAC7B,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EACjB,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,mBAAmB,CAAC,CACrD,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CACnC,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,EACvB,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,yBAAyB,CAAC,CAC3D,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ;IACtB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;IACtB,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAU;IAChC,OAAO,YAAY,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,EAAU;IACtC,IAAI,CAAC;QACH,mBAAmB;QACnB,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,EAAU,EAAE,UAAmB;IACzD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gBAAgB,EAAE,IAAI,UAAU,CAAC,CAAC,CAAC,QAAQ,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAM;IAC5B,OAAO,SAAS,CAAC,EAAE,CAAC,CAAC;AACvB,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,MAAM,WAAW,GAAG,kEAAkE,CAAC;AAEvF,MAAM,UAAU,QAAQ,CAAC,EAAM;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAC1B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,CAAS,CAAC;IAEd,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACnB,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QAE5B,mBAAmB;QACnB,MAAM,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QAExC,MAAM,IAAI,WAAW,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,IAAI,WAAW,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QACzE,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACpE,CAAC;IAED,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,EAAY;IACrC,MAAM,KAAK,GAAG,EAAE,CAAC;IAEjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACtC,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1C,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC1C,mBAAmB;QACnB,MAAM,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAE1C,MAAM,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;QAEtE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAClC,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAC7D,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,SAAS,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AAC1C,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"idv2.test.d.ts","sourceRoot":"","sources":["../../src/idv2.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { expect, it } from 'vitest';
|
|
2
|
+
import { Id, generate, isValid, toBase64 } from './idv2.js';
|
|
3
|
+
it('should generate valid uuid', () => {
|
|
4
|
+
const id = generate();
|
|
5
|
+
expect(id).toBeTypeOf('string');
|
|
6
|
+
expect(id.length).toBe(36);
|
|
7
|
+
expect(id).toMatch(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/);
|
|
8
|
+
});
|
|
9
|
+
it('should validate uuid', () => {
|
|
10
|
+
expect(isValid(generate())).toBe(true);
|
|
11
|
+
expect(isValid(generate())).toBe(true);
|
|
12
|
+
expect(isValid(generate())).toBe(true);
|
|
13
|
+
expect(isValid('3af3e22d-2169-4a07-8681-516710b7ecf1')).toBe(true);
|
|
14
|
+
});
|
|
15
|
+
it('should not validate invalid id', () => {
|
|
16
|
+
expect(isValid('invalid-id')).toBe(false);
|
|
17
|
+
expect(isValid('0123456789012345678901')).toBe(false);
|
|
18
|
+
});
|
|
19
|
+
it('should convert id to base64', () => {
|
|
20
|
+
const id = Id('3af3e22d-2169-4a07-8681-516710b7ecf1');
|
|
21
|
+
const base64 = toBase64(id);
|
|
22
|
+
expect(base64).toBeTypeOf('string');
|
|
23
|
+
expect(base64).toBe('OvPiLSFpSgeGgVFnELfs8Q==');
|
|
24
|
+
expect(toBase64(Id('1d501a3a-d6ce-4693-bc90-d25286f21c7e'))).toBe('HVAaOtbORpO8kNJShvIcfg==');
|
|
25
|
+
});
|
|
26
|
+
//# sourceMappingURL=idv2.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"idv2.test.js","sourceRoot":"","sources":["../../src/idv2.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEpC,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE5D,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACpC,MAAM,EAAE,GAAG,QAAQ,EAAE,CAAC;IACtB,MAAM,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,+EAA+E,CAAC,CAAC;AACtG,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAC9B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,OAAO,CAAC,sCAAsC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACrE,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;IACxC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1C,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC,CAAC,CAAC;AAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;IACrC,MAAM,EAAE,GAAG,EAAE,CAAC,sCAAsC,CAAC,CAAC;IACtD,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;IAChD,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,sCAAsC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;AAChG,CAAC,CAAC,CAAC"}
|
package/dist/src/ipfs.d.ts
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
*
|
|
5
5
|
* @since 0.1.1
|
|
6
6
|
*/
|
|
7
|
-
import { Id } from './id.js';
|
|
7
|
+
import { type Id } from './id.js';
|
|
8
8
|
import type { Op } from './types.js';
|
|
9
9
|
type PublishEditProposalParams = {
|
|
10
10
|
name: string;
|
|
11
11
|
ops: Op[];
|
|
12
|
-
author: string
|
|
12
|
+
author: `0x${string}`;
|
|
13
13
|
};
|
|
14
14
|
type PublishEditResult = {
|
|
15
15
|
cid: string;
|
package/dist/src/ipfs.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ipfs.d.ts","sourceRoot":"","sources":["../../src/ipfs.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"ipfs.d.ts","sourceRoot":"","sources":["../../src/ipfs.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,OAAO,EAAE,KAAK,EAAE,EAAa,MAAM,SAAS,CAAC;AAC7C,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AAMrC,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,EAAE,EAAE,CAAC;IACV,MAAM,EAAE,KAAK,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF,KAAK,iBAAiB,GAAG;IAEvB,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,EAAE,CAAC;CACZ,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7F;AAED,KAAK,kBAAkB,GACnB;IACE,IAAI,EAAE,IAAI,CAAC;CACZ,GACD;IACE,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEN,wBAAsB,WAAW,CAAC,MAAM,EAAE,kBAAkB;;;;;;;;;GAkC3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAsB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,MAAM,EAAE,CAAC,CAS9E"}
|
package/dist/src/ipfs.js
CHANGED
|
@@ -8,7 +8,7 @@ import { Micro } from 'effect';
|
|
|
8
8
|
import { gzipSync } from 'fflate';
|
|
9
9
|
import { imageSize } from 'image-size';
|
|
10
10
|
import { Edit, EditProposal } from '../proto.js';
|
|
11
|
-
import {
|
|
11
|
+
import { fromBytes } from './id.js';
|
|
12
12
|
class IpfsUploadError extends Error {
|
|
13
13
|
_tag = 'IpfsUploadError';
|
|
14
14
|
}
|
|
@@ -37,7 +37,7 @@ export async function publishEdit(args) {
|
|
|
37
37
|
formData.append('file', blob);
|
|
38
38
|
const cid = await Micro.runPromise(uploadBinary(formData));
|
|
39
39
|
const result = Edit.fromBinary(edit);
|
|
40
|
-
return { cid, editId:
|
|
40
|
+
return { cid, editId: fromBytes(result.id) };
|
|
41
41
|
}
|
|
42
42
|
export async function uploadImage(params) {
|
|
43
43
|
const formData = new FormData();
|
package/dist/src/ipfs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ipfs.js","sourceRoot":"","sources":["../../src/ipfs.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,
|
|
1
|
+
{"version":3,"file":"ipfs.js","sourceRoot":"","sources":["../../src/ipfs.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAW,SAAS,EAAE,MAAM,SAAS,CAAC;AAG7C,MAAM,eAAgB,SAAQ,KAAK;IACxB,IAAI,GAAG,iBAAiB,CAAC;CACnC;AAeD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAA+B;IAC/D,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEnC,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAC;IAExD,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC;IACpE,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE9B,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAErC,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;AAC/C,CAAC;AAUD,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAA0B;IAC1D,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,IAAI,IAAU,CAAC;IACf,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QACrB,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,wCAAwC;QACxC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAE9B,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACrD,IAAI,UAAyD,CAAC;IAC9D,IAAI,CAAC;QACH,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC,CAAA,CAAC;IAElB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzD,IAAI,UAAU,EAAE,CAAC;QACf,OAAO;YACL,GAAG;YACH,UAAU,EAAE;gBACV,KAAK,EAAE,UAAU,CAAC,KAAK;gBACvB,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B;SACF,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG;KACJ,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,SAAiB;IAC/C,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;IAClC,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,CAAC;IAE5C,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;IAEhE,OAAO,MAAM,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,SAAS,YAAY,CAAC,QAAkB;IACtC,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;QACxB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACrC,GAAG,EAAE,GAAG,EAAE,CACR,KAAK,CAAC,0DAA0D,EAAE;gBAChE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,QAAQ;aACf,CAAC;YACJ,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,kCAAkC,KAAK,EAAE,CAAC;SAC/E,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACvC,GAAG,EAAE,KAAK,IAAI,EAAE;gBACd,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBACpC,OAAO,GAAG,CAAC;YACb,CAAC;YACD,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,uCAAuC,KAAK,EAAE,CAAC;SACpF,CAAC,CAAC;QAEH,OAAO,QAA8B,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CAAC,QAAkB;IACpC,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC;QACxB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACrC,GAAG,EAAE,GAAG,EAAE,CACR,KAAK,CAAC,0DAA0D,EAAE;gBAChE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,QAAQ;aACf,CAAC;YACJ,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,kCAAkC,KAAK,EAAE,CAAC;SAC/E,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;YACvC,GAAG,EAAE,KAAK,IAAI,EAAE;gBACd,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBACpC,OAAO,GAAG,CAAC;YACb,CAAC;YACD,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,eAAe,CAAC,uCAAuC,KAAK,EAAE,CAAC;SACpF,CAAC,CAAC;QAEH,OAAO,QAA8B,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ipfs.test.d.ts","sourceRoot":"","sources":["../../src/ipfs.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { it } from 'vitest';
|
|
2
|
+
import { WEBSITE_PROPERTY } from './core/ids/content.js';
|
|
3
|
+
import { createEntity } from './graph/create-entity.js';
|
|
4
|
+
import { publishEdit } from './ipfs.js';
|
|
5
|
+
it('full flow', async () => {
|
|
6
|
+
const { id, ops } = createEntity({
|
|
7
|
+
name: 'test',
|
|
8
|
+
description: 'test',
|
|
9
|
+
values: {
|
|
10
|
+
[WEBSITE_PROPERTY]: {
|
|
11
|
+
value: 'test',
|
|
12
|
+
},
|
|
13
|
+
},
|
|
14
|
+
});
|
|
15
|
+
const { cid, editId } = await publishEdit({
|
|
16
|
+
name: 'test',
|
|
17
|
+
ops,
|
|
18
|
+
author: '0x000000000000000000000000000000000000',
|
|
19
|
+
});
|
|
20
|
+
console.log(cid, editId);
|
|
21
|
+
});
|
|
22
|
+
//# sourceMappingURL=ipfs.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ipfs.test.js","sourceRoot":"","sources":["../../src/ipfs.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,EAAE,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;IACzB,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,YAAY,CAAC;QAC/B,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,MAAM;QACnB,MAAM,EAAE;YACN,CAAC,gBAAgB,CAAC,EAAE;gBAClB,KAAK,EAAE,MAAM;aACd;SACF;KACF,CAAC,CAAC;IAEH,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,WAAW,CAAC;QACxC,IAAI,EAAE,MAAM;QACZ,GAAG;QACH,MAAM,EAAE,wCAAwC;KACjD,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AAC3B,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This module provides utility functions for interacting with the default
|
|
3
|
+
* IPFS gateway in TypeScript.
|
|
4
|
+
*
|
|
5
|
+
* @since 0.1.1
|
|
6
|
+
*/
|
|
7
|
+
import { type Id } from './idv2.js';
|
|
8
|
+
import type { Op } from './typesv2.js';
|
|
9
|
+
type PublishEditProposalParams = {
|
|
10
|
+
name: string;
|
|
11
|
+
ops: Op[];
|
|
12
|
+
author: string;
|
|
13
|
+
};
|
|
14
|
+
type PublishEditResult = {
|
|
15
|
+
cid: string;
|
|
16
|
+
editId: Id;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Generates correct protobuf encoding for an Edit and uploads it to IPFS.
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* ```ts
|
|
23
|
+
* import { IPFS } from '@graphprotocol/grc-20';
|
|
24
|
+
*
|
|
25
|
+
* const { cid, editId } = await IPFS.publishEdit({
|
|
26
|
+
* name: 'Edit name',
|
|
27
|
+
* ops: ops,
|
|
28
|
+
* author: '0x000000000000000000000000000000000000',
|
|
29
|
+
* });
|
|
30
|
+
* ```
|
|
31
|
+
*
|
|
32
|
+
* @param args arguments for publishing an edit to IPFS {@link PublishEditProposalParams}
|
|
33
|
+
* @returns - {@link PublishEditResult}
|
|
34
|
+
*/
|
|
35
|
+
export declare function publishEdit(args: PublishEditProposalParams): Promise<PublishEditResult>;
|
|
36
|
+
type PublishImageParams = {
|
|
37
|
+
blob: Blob;
|
|
38
|
+
} | {
|
|
39
|
+
url: string;
|
|
40
|
+
};
|
|
41
|
+
export declare function uploadImage(params: PublishImageParams): Promise<{
|
|
42
|
+
cid: `ipfs://${string}`;
|
|
43
|
+
dimensions: {
|
|
44
|
+
width: number;
|
|
45
|
+
height: number;
|
|
46
|
+
};
|
|
47
|
+
} | {
|
|
48
|
+
cid: `ipfs://${string}`;
|
|
49
|
+
dimensions?: undefined;
|
|
50
|
+
}>;
|
|
51
|
+
/**
|
|
52
|
+
* Uploads a CSV file to IPFS and returns the CID. This CSV
|
|
53
|
+
* file will be compressed using gzip before being uploaded.
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* ```ts
|
|
57
|
+
* const file = Bun.file('cities.csv');
|
|
58
|
+
* const fileText = await file.text();
|
|
59
|
+
*
|
|
60
|
+
* const cid = await Ipfs.uploadCSV(fileText);
|
|
61
|
+
* ```
|
|
62
|
+
*
|
|
63
|
+
* @example
|
|
64
|
+
* ```ts
|
|
65
|
+
* import { Csv } from '@graphprotocol/grc-20';
|
|
66
|
+
*
|
|
67
|
+
* const csvString = Csv.stringify({
|
|
68
|
+
* data: Array.from({ length: 151_000 }, (_, i: number) => [i.toString(), (i * 2).toString(), (i * 3).toString()]),
|
|
69
|
+
* metadata: {
|
|
70
|
+
* filetype: 'CSV',
|
|
71
|
+
* columns: [
|
|
72
|
+
* {
|
|
73
|
+
* id: 'foo',
|
|
74
|
+
* type: 'TEXT',
|
|
75
|
+
* },
|
|
76
|
+
* {
|
|
77
|
+
* id: 'bar',
|
|
78
|
+
* type: 'NUMBER',
|
|
79
|
+
* },
|
|
80
|
+
* {
|
|
81
|
+
* id: 'baz',
|
|
82
|
+
* type: 'TEXT',
|
|
83
|
+
* },
|
|
84
|
+
* ],
|
|
85
|
+
* },
|
|
86
|
+
* })
|
|
87
|
+
*
|
|
88
|
+
* const cid = await Ipfs.uploadCSV(csvString);
|
|
89
|
+
* ```
|
|
90
|
+
*
|
|
91
|
+
* @param csvString The CSV to upload as a string
|
|
92
|
+
* @returns IPFS CID representing the uploaded file prefixed with `ipfs://`
|
|
93
|
+
*/
|
|
94
|
+
export declare function uploadCSV(csvString: string): Promise<`ipfs://${string}`>;
|
|
95
|
+
export {};
|
|
96
|
+
//# sourceMappingURL=ipfsv2.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ipfsv2.d.ts","sourceRoot":"","sources":["../../src/ipfsv2.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,OAAO,EAAE,KAAK,EAAE,EAAa,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAMvC,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,EAAE,EAAE,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,iBAAiB,GAAG;IAEvB,GAAG,EAAE,MAAM,CAAC;IAEZ,MAAM,EAAE,EAAE,CAAC;CACZ,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,WAAW,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAa7F;AAED,KAAK,kBAAkB,GACnB;IACE,IAAI,EAAE,IAAI,CAAC;CACZ,GACD;IACE,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEN,wBAAsB,WAAW,CAAC,MAAM,EAAE,kBAAkB;;;;;;;;;GAkC3D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAsB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,MAAM,EAAE,CAAC,CAS9E"}
|