@learncard/core 8.0.7 → 8.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/core.cjs.development.js +6069 -43
  2. package/dist/core.cjs.development.js.map +4 -4
  3. package/dist/core.cjs.production.min.js +440 -413
  4. package/dist/core.cjs.production.min.js.map +4 -4
  5. package/dist/core.d.ts +44 -24
  6. package/dist/core.esm.js +6069 -43
  7. package/dist/core.esm.js.map +4 -4
  8. package/package.json +3 -2
package/dist/core.d.ts CHANGED
@@ -3,6 +3,7 @@
3
3
  import { CeramicClient } from '@ceramicnetwork/http-client';
4
4
  import { StreamID } from '@ceramicnetwork/streamid';
5
5
  import { ModelAliases } from '@glazed/types';
6
+ import { CreateJWEOptions } from 'dids';
6
7
 
7
8
  export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
8
9
  declare const UnsignedVCValidator: z.ZodObject<{
@@ -4736,9 +4737,13 @@ export declare type PluginReadPlane = ReadPlane;
4736
4737
  export declare type LearnCardReadPlane<Plugins extends Plugin[]> = ReadPlane & {
4737
4738
  providers: GetPlaneProviders<Plugins, "read">;
4738
4739
  };
4740
+ export declare type EncryptionParams = {
4741
+ recipients: string[];
4742
+ };
4739
4743
  export declare type StorePlane = {
4740
4744
  upload: (vc: VC, options?: PlaneOptions) => Promise<string>;
4741
4745
  uploadMany?: (vcs: VC[], options?: PlaneOptions) => Promise<string[]>;
4746
+ uploadEncrypted?: (vc: VC, params?: EncryptionParams, options?: PlaneOptions) => Promise<string>;
4742
4747
  };
4743
4748
  export declare type PluginStorePlane = StorePlane;
4744
4749
  export declare type LearnCardStorePlane<Plugins extends Plugin[]> = Record<FilterForPlane<Plugins, "store">, StorePlane> & {
@@ -4746,7 +4751,8 @@ export declare type LearnCardStorePlane<Plugins extends Plugin[]> = Record<Filte
4746
4751
  };
4747
4752
  export declare type IndexPlane = {
4748
4753
  get: <Metadata extends Record<string, any> = Record<never, never>>(query?: Record<string, any>, options?: PlaneOptions) => Promise<CredentialRecord<Metadata>[]>;
4749
- add: <Metadata extends Record<string, any> = Record<never, never>>(obj: CredentialRecord<Metadata>, options?: PlaneOptions) => Promise<boolean>;
4754
+ add: <Metadata extends Record<string, any> = Record<never, never>>(record: CredentialRecord<Metadata>, options?: PlaneOptions) => Promise<boolean>;
4755
+ addMany?: <Metadata extends Record<string, any> = Record<never, never>>(records: CredentialRecord<Metadata>[], options?: PlaneOptions) => Promise<boolean>;
4750
4756
  update: (id: string, updates: Record<string, any>, options?: PlaneOptions) => Promise<boolean>;
4751
4757
  remove: (id: string, options?: PlaneOptions) => Promise<boolean>;
4752
4758
  removeAll?: (options?: PlaneOptions) => Promise<boolean>;
@@ -5003,9 +5009,23 @@ export declare type CeramicArgs = {
5003
5009
  export declare type CeramicURI = `lc:ceramic:${string}`;
5004
5010
  /** @group CeramicPlugin */
5005
5011
  export declare const CeramicURIValidator: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
5012
+ /**
5013
+ * Settings for toggling JWE Encryption before uploading to Ceramic.
5014
+ * @group CeramicPlugin
5015
+ * @param encrypt enable JWE encryption on upload.
5016
+ * @param controllersCanDecrypt helper to add Ceramic controller DIDs to recipients who can decrypt the JWE credential.
5017
+ * @param recipients DIDs who can decrypt the JWE credential.
5018
+ * @param options additional CreateJWEOptions for encryption.
5019
+ */
5020
+ export declare type CeramicEncryptionParams = {
5021
+ encrypt: boolean;
5022
+ controllersCanDecrypt?: boolean;
5023
+ recipients?: string[] | undefined;
5024
+ options?: CreateJWEOptions | undefined;
5025
+ };
5006
5026
  /** @group CeramicPlugin */
5007
5027
  export declare type CeramicPluginMethods<URI extends string = ""> = {
5008
- publishContentToCeramic: (cred: any) => Promise<CeramicURI>;
5028
+ publishContentToCeramic: (cred: any, encryption: CeramicEncryptionParams | undefined) => Promise<CeramicURI>;
5009
5029
  readContentFromCeramic: (streamId: string) => Promise<any>;
5010
5030
  getCeramicClient: () => CeramicClient;
5011
5031
  } & ResolutionExtension<URI | CeramicURI>;
@@ -5361,7 +5381,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5361
5381
  name: string;
5362
5382
  displayName?: string | undefined;
5363
5383
  description?: string | undefined;
5364
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5384
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5365
5385
  _methods?: Record<never, never> | undefined;
5366
5386
  read?: {} | undefined;
5367
5387
  store?: {} | undefined;
@@ -5378,7 +5398,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5378
5398
  name: string;
5379
5399
  displayName?: string | undefined;
5380
5400
  description?: string | undefined;
5381
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5401
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5382
5402
  _methods?: Record<never, never> | undefined;
5383
5403
  read?: {} | undefined;
5384
5404
  store?: {} | undefined;
@@ -5396,7 +5416,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5396
5416
  name: string;
5397
5417
  displayName?: string | undefined;
5398
5418
  description?: string | undefined;
5399
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5419
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5400
5420
  _methods?: Record<never, never> | undefined;
5401
5421
  read?: {} | undefined;
5402
5422
  store?: {} | undefined;
@@ -5415,7 +5435,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5415
5435
  name: string;
5416
5436
  displayName?: string | undefined;
5417
5437
  description?: string | undefined;
5418
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5438
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5419
5439
  _methods?: Record<never, never> | undefined;
5420
5440
  read?: {} | undefined;
5421
5441
  store?: {} | undefined;
@@ -5435,7 +5455,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5435
5455
  name: string;
5436
5456
  displayName?: string | undefined;
5437
5457
  description?: string | undefined;
5438
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5458
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5439
5459
  _methods?: Record<never, never> | undefined;
5440
5460
  read?: {} | undefined;
5441
5461
  store?: {} | undefined;
@@ -5456,7 +5476,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5456
5476
  name: string;
5457
5477
  displayName?: string | undefined;
5458
5478
  description?: string | undefined;
5459
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5479
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5460
5480
  _methods?: Record<never, never> | undefined;
5461
5481
  read?: {} | undefined;
5462
5482
  store?: {} | undefined;
@@ -5478,7 +5498,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5478
5498
  name: string;
5479
5499
  displayName?: string | undefined;
5480
5500
  description?: string | undefined;
5481
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5501
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5482
5502
  _methods?: Record<never, never> | undefined;
5483
5503
  read?: {} | undefined;
5484
5504
  store?: {} | undefined;
@@ -5501,7 +5521,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5501
5521
  name: string;
5502
5522
  displayName?: string | undefined;
5503
5523
  description?: string | undefined;
5504
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5524
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5505
5525
  _methods?: Record<never, never> | undefined;
5506
5526
  read?: {} | undefined;
5507
5527
  store?: {} | undefined;
@@ -5525,7 +5545,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5525
5545
  name: string;
5526
5546
  displayName?: string | undefined;
5527
5547
  description?: string | undefined;
5528
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5548
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5529
5549
  _methods?: Record<never, never> | undefined;
5530
5550
  read?: {} | undefined;
5531
5551
  store?: {} | undefined;
@@ -5550,7 +5570,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5550
5570
  name: string;
5551
5571
  displayName?: string | undefined;
5552
5572
  description?: string | undefined;
5553
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5573
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5554
5574
  _methods?: Record<never, never> | undefined;
5555
5575
  read?: {} | undefined;
5556
5576
  store?: {} | undefined;
@@ -5576,7 +5596,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5576
5596
  name: string;
5577
5597
  displayName?: string | undefined;
5578
5598
  description?: string | undefined;
5579
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5599
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5580
5600
  _methods?: Record<never, never> | undefined;
5581
5601
  read?: {} | undefined;
5582
5602
  store?: {} | undefined;
@@ -5650,7 +5670,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5650
5670
  name: string;
5651
5671
  displayName?: string | undefined;
5652
5672
  description?: string | undefined;
5653
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5673
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5654
5674
  _methods?: Record<never, never> | undefined;
5655
5675
  read?: {} | undefined;
5656
5676
  store?: {} | undefined;
@@ -5667,7 +5687,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5667
5687
  name: string;
5668
5688
  displayName?: string | undefined;
5669
5689
  description?: string | undefined;
5670
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5690
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5671
5691
  _methods?: Record<never, never> | undefined;
5672
5692
  read?: {} | undefined;
5673
5693
  store?: {} | undefined;
@@ -5685,7 +5705,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5685
5705
  name: string;
5686
5706
  displayName?: string | undefined;
5687
5707
  description?: string | undefined;
5688
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5708
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5689
5709
  _methods?: Record<never, never> | undefined;
5690
5710
  read?: {} | undefined;
5691
5711
  store?: {} | undefined;
@@ -5704,7 +5724,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5704
5724
  name: string;
5705
5725
  displayName?: string | undefined;
5706
5726
  description?: string | undefined;
5707
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5727
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5708
5728
  _methods?: Record<never, never> | undefined;
5709
5729
  read?: {} | undefined;
5710
5730
  store?: {} | undefined;
@@ -5724,7 +5744,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5724
5744
  name: string;
5725
5745
  displayName?: string | undefined;
5726
5746
  description?: string | undefined;
5727
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5747
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5728
5748
  _methods?: Record<never, never> | undefined;
5729
5749
  read?: {} | undefined;
5730
5750
  store?: {} | undefined;
@@ -5745,7 +5765,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5745
5765
  name: string;
5746
5766
  displayName?: string | undefined;
5747
5767
  description?: string | undefined;
5748
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5768
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5749
5769
  _methods?: Record<never, never> | undefined;
5750
5770
  read?: {} | undefined;
5751
5771
  store?: {} | undefined;
@@ -5767,7 +5787,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5767
5787
  name: string;
5768
5788
  displayName?: string | undefined;
5769
5789
  description?: string | undefined;
5770
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5790
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5771
5791
  _methods?: Record<never, never> | undefined;
5772
5792
  read?: {} | undefined;
5773
5793
  store?: {} | undefined;
@@ -5790,7 +5810,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5790
5810
  name: string;
5791
5811
  displayName?: string | undefined;
5792
5812
  description?: string | undefined;
5793
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5813
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5794
5814
  _methods?: Record<never, never> | undefined;
5795
5815
  read?: {} | undefined;
5796
5816
  store?: {} | undefined;
@@ -5814,7 +5834,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5814
5834
  name: string;
5815
5835
  displayName?: string | undefined;
5816
5836
  description?: string | undefined;
5817
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5837
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5818
5838
  _methods?: Record<never, never> | undefined;
5819
5839
  read?: {} | undefined;
5820
5840
  store?: {} | undefined;
@@ -5839,7 +5859,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5839
5859
  name: string;
5840
5860
  displayName?: string | undefined;
5841
5861
  description?: string | undefined;
5842
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5862
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5843
5863
  _methods?: Record<never, never> | undefined;
5844
5864
  read?: {} | undefined;
5845
5865
  store?: {} | undefined;
@@ -5865,7 +5885,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5865
5885
  name: string;
5866
5886
  displayName?: string | undefined;
5867
5887
  description?: string | undefined;
5868
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5888
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5869
5889
  _methods?: Record<never, never> | undefined;
5870
5890
  read?: {} | undefined;
5871
5891
  store?: {} | undefined;