Skip to content

chore: make source optional in collection #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

chore: make source optional in collection #711

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/src/opentdf.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ export type CreateNanoTDFCollectionOptions = CreateNanoTDFOptions & {
platformUrl: string;
/** The maximum number of key iterations to use for a single DEK. */
maxKeyIterations?: number;
/** Optional source. TODO: check if it can be removed from create options */
source?: Source;
Comment on lines +103 to +104
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

This change is intended to make the source property optional, but it won't have the desired effect. CreateNanoTDFCollectionOptions is defined as an intersection with CreateNanoTDFOptions, which inherits a required source property from CreateOptions. In a TypeScript intersection, a required property remains required even if intersected with a type where it's optional.

The correct way to achieve this is to modify the definition of CreateNanoTDFCollectionOptions to use Omit<CreateNanoTDFOptions, 'source'>. This would properly remove the required source property. The source?: Source could then be added back to allow it to be passed through from createNanoTDF without being mandatory for direct createNanoTDFCollection calls.

Example of a corrected definition:

export type CreateNanoTDFCollectionOptions = Omit<CreateNanoTDFOptions, 'source'> & {
  platformUrl: string;
  maxKeyIterations?: number;
  source?: Source;
};

This change would need to be applied to the definition of CreateNanoTDFCollectionOptions on line 98, which is outside the current diff.

};

/** Metadata for a TDF object. */
Expand Down
Loading