@learncard/core 8.0.7 → 8.1.1

Sign up to get free protection for your applications and to get access to all the features.
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> & {
@@ -5003,9 +5008,23 @@ export declare type CeramicArgs = {
5003
5008
  export declare type CeramicURI = `lc:ceramic:${string}`;
5004
5009
  /** @group CeramicPlugin */
5005
5010
  export declare const CeramicURIValidator: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
5011
+ /**
5012
+ * Settings for toggling JWE Encryption before uploading to Ceramic.
5013
+ * @group CeramicPlugin
5014
+ * @param encrypt enable JWE encryption on upload.
5015
+ * @param controllersCanDecrypt helper to add Ceramic controller DIDs to recipients who can decrypt the JWE credential.
5016
+ * @param recipients DIDs who can decrypt the JWE credential.
5017
+ * @param options additional CreateJWEOptions for encryption.
5018
+ */
5019
+ export declare type CeramicEncryptionParams = {
5020
+ encrypt: boolean;
5021
+ controllersCanDecrypt?: boolean;
5022
+ recipients?: string[] | undefined;
5023
+ options?: CreateJWEOptions | undefined;
5024
+ };
5006
5025
  /** @group CeramicPlugin */
5007
5026
  export declare type CeramicPluginMethods<URI extends string = ""> = {
5008
- publishContentToCeramic: (cred: any) => Promise<CeramicURI>;
5027
+ publishContentToCeramic: (cred: any, encryption: CeramicEncryptionParams | undefined) => Promise<CeramicURI>;
5009
5028
  readContentFromCeramic: (streamId: string) => Promise<any>;
5010
5029
  getCeramicClient: () => CeramicClient;
5011
5030
  } & ResolutionExtension<URI | CeramicURI>;
@@ -5361,7 +5380,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5361
5380
  name: string;
5362
5381
  displayName?: string | undefined;
5363
5382
  description?: string | undefined;
5364
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5383
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5365
5384
  _methods?: Record<never, never> | undefined;
5366
5385
  read?: {} | undefined;
5367
5386
  store?: {} | undefined;
@@ -5378,7 +5397,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5378
5397
  name: string;
5379
5398
  displayName?: string | undefined;
5380
5399
  description?: string | undefined;
5381
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5400
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5382
5401
  _methods?: Record<never, never> | undefined;
5383
5402
  read?: {} | undefined;
5384
5403
  store?: {} | undefined;
@@ -5396,7 +5415,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5396
5415
  name: string;
5397
5416
  displayName?: string | undefined;
5398
5417
  description?: string | undefined;
5399
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5418
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5400
5419
  _methods?: Record<never, never> | undefined;
5401
5420
  read?: {} | undefined;
5402
5421
  store?: {} | undefined;
@@ -5415,7 +5434,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5415
5434
  name: string;
5416
5435
  displayName?: string | undefined;
5417
5436
  description?: string | undefined;
5418
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5437
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5419
5438
  _methods?: Record<never, never> | undefined;
5420
5439
  read?: {} | undefined;
5421
5440
  store?: {} | undefined;
@@ -5435,7 +5454,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5435
5454
  name: string;
5436
5455
  displayName?: string | undefined;
5437
5456
  description?: string | undefined;
5438
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5457
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5439
5458
  _methods?: Record<never, never> | undefined;
5440
5459
  read?: {} | undefined;
5441
5460
  store?: {} | undefined;
@@ -5456,7 +5475,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5456
5475
  name: string;
5457
5476
  displayName?: string | undefined;
5458
5477
  description?: string | undefined;
5459
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5478
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5460
5479
  _methods?: Record<never, never> | undefined;
5461
5480
  read?: {} | undefined;
5462
5481
  store?: {} | undefined;
@@ -5478,7 +5497,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5478
5497
  name: string;
5479
5498
  displayName?: string | undefined;
5480
5499
  description?: string | undefined;
5481
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5500
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5482
5501
  _methods?: Record<never, never> | undefined;
5483
5502
  read?: {} | undefined;
5484
5503
  store?: {} | undefined;
@@ -5501,7 +5520,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5501
5520
  name: string;
5502
5521
  displayName?: string | undefined;
5503
5522
  description?: string | undefined;
5504
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5523
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5505
5524
  _methods?: Record<never, never> | undefined;
5506
5525
  read?: {} | undefined;
5507
5526
  store?: {} | undefined;
@@ -5525,7 +5544,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5525
5544
  name: string;
5526
5545
  displayName?: string | undefined;
5527
5546
  description?: string | undefined;
5528
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5547
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5529
5548
  _methods?: Record<never, never> | undefined;
5530
5549
  read?: {} | undefined;
5531
5550
  store?: {} | undefined;
@@ -5550,7 +5569,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5550
5569
  name: string;
5551
5570
  displayName?: string | undefined;
5552
5571
  description?: string | undefined;
5553
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5572
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5554
5573
  _methods?: Record<never, never> | undefined;
5555
5574
  read?: {} | undefined;
5556
5575
  store?: {} | undefined;
@@ -5576,7 +5595,7 @@ export declare const getCeramicPlugin: <URI extends string = "">(learnCard: {
5576
5595
  name: string;
5577
5596
  displayName?: string | undefined;
5578
5597
  description?: string | undefined;
5579
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5598
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5580
5599
  _methods?: Record<never, never> | undefined;
5581
5600
  read?: {} | undefined;
5582
5601
  store?: {} | undefined;
@@ -5650,7 +5669,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5650
5669
  name: string;
5651
5670
  displayName?: string | undefined;
5652
5671
  description?: string | undefined;
5653
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5672
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5654
5673
  _methods?: Record<never, never> | undefined;
5655
5674
  read?: {} | undefined;
5656
5675
  store?: {} | undefined;
@@ -5667,7 +5686,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5667
5686
  name: string;
5668
5687
  displayName?: string | undefined;
5669
5688
  description?: string | undefined;
5670
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5689
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5671
5690
  _methods?: Record<never, never> | undefined;
5672
5691
  read?: {} | undefined;
5673
5692
  store?: {} | undefined;
@@ -5685,7 +5704,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5685
5704
  name: string;
5686
5705
  displayName?: string | undefined;
5687
5706
  description?: string | undefined;
5688
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5707
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5689
5708
  _methods?: Record<never, never> | undefined;
5690
5709
  read?: {} | undefined;
5691
5710
  store?: {} | undefined;
@@ -5704,7 +5723,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5704
5723
  name: string;
5705
5724
  displayName?: string | undefined;
5706
5725
  description?: string | undefined;
5707
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5726
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5708
5727
  _methods?: Record<never, never> | undefined;
5709
5728
  read?: {} | undefined;
5710
5729
  store?: {} | undefined;
@@ -5724,7 +5743,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5724
5743
  name: string;
5725
5744
  displayName?: string | undefined;
5726
5745
  description?: string | undefined;
5727
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5746
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5728
5747
  _methods?: Record<never, never> | undefined;
5729
5748
  read?: {} | undefined;
5730
5749
  store?: {} | undefined;
@@ -5745,7 +5764,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5745
5764
  name: string;
5746
5765
  displayName?: string | undefined;
5747
5766
  description?: string | undefined;
5748
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5767
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5749
5768
  _methods?: Record<never, never> | undefined;
5750
5769
  read?: {} | undefined;
5751
5770
  store?: {} | undefined;
@@ -5767,7 +5786,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5767
5786
  name: string;
5768
5787
  displayName?: string | undefined;
5769
5788
  description?: string | undefined;
5770
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5789
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5771
5790
  _methods?: Record<never, never> | undefined;
5772
5791
  read?: {} | undefined;
5773
5792
  store?: {} | undefined;
@@ -5790,7 +5809,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5790
5809
  name: string;
5791
5810
  displayName?: string | undefined;
5792
5811
  description?: string | undefined;
5793
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5812
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5794
5813
  _methods?: Record<never, never> | undefined;
5795
5814
  read?: {} | undefined;
5796
5815
  store?: {} | undefined;
@@ -5814,7 +5833,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5814
5833
  name: string;
5815
5834
  displayName?: string | undefined;
5816
5835
  description?: string | undefined;
5817
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5836
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5818
5837
  _methods?: Record<never, never> | undefined;
5819
5838
  read?: {} | undefined;
5820
5839
  store?: {} | undefined;
@@ -5839,7 +5858,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5839
5858
  name: string;
5840
5859
  displayName?: string | undefined;
5841
5860
  description?: string | undefined;
5842
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5861
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5843
5862
  _methods?: Record<never, never> | undefined;
5844
5863
  read?: {} | undefined;
5845
5864
  store?: {} | undefined;
@@ -5865,7 +5884,7 @@ export declare const getDidKeyPlugin: <DidMethod extends string>(learnCard: {
5865
5884
  name: string;
5866
5885
  displayName?: string | undefined;
5867
5886
  description?: string | undefined;
5868
- methods: import("types/wallet").AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5887
+ methods: AddImplicitLearnCardArgument<Record<never, never>, any, Record<never, never>, never, Record<never, never>>;
5869
5888
  _methods?: Record<never, never> | undefined;
5870
5889
  read?: {} | undefined;
5871
5890
  store?: {} | undefined;