Merge pull request #15 from toothlessdev/11-partition-canonical-api-spec-output

Add Hash, Index Signature in Canonical Spec

Author: toothlessdev

packages/patchlogr-core/src/partition/partition.ts

@@ -1,14 +1,10 @@
-export type PartitionManifest = {
-    key: string;
-    hash: string;
-};
-
 export type Partition = {
     hash: string;
     operationKey: string;
 };
 
 export type PartitionedSpec = {
+    hash: string;
     metadata: Record<string, unknown>;
     partitions: Map<string, Partition[]>;
 };

packages/patchlogr-core/src/partition/partitionByMethod.ts

@@ -17,6 +17,7 @@ export function partitionByMethod(spec: CanonicalSpec): PartitionedSpec {
     });
 
     return {
+        hash: createSHA256Hash(stableStringify(spec)),
         metadata: {
             ...spec.info,
             ...spec.security,

packages/patchlogr-core/src/partition/partitionByTag.ts

@@ -19,6 +19,7 @@ export function partitionByTag(spec: CanonicalSpec): PartitionedSpec {
     });
 
     return {
+        hash: createSHA256Hash(stableStringify(spec)),
         metadata: {
             ...spec.info,
             ...spec.security,

packages/patchlogr-types/src/index.ts

@@ -188,7 +188,7 @@ export type CanonicalOperation = CanonicalOperationContract & {
     doc?: CanonicalOperationDoc;
 };
 
-export interface CanonicalSpec {
+export type CanonicalSpec = {
     info?: {
         title?: string;
         version?: string;
@@ -202,4 +202,4 @@ export interface CanonicalSpec {
      */
     security?: CanonicalSecurityRequirement[];
     operations: Record<OperationKey, CanonicalOperation>;
-}
+};