Add sync skeleton

src/commands/generateSyncModel.ts

@@ -0,0 +1,44 @@
+import { LogOptions } from "../log.js";
+import { generateSyncModelToFile } from "../modules/sync/generateSyncModel.js";
+import { RegisterCommand } from "../types/yargs.js";
+
+export const generateSyncModel: RegisterCommand = yargs =>
+  yargs.command(
+    {
+      command: "generate-sync-model",
+      describe: "generates content model json file used for sync from Kontent.ai environment",
+      builder: yargs =>
+        yargs
+        .option("environmentId", {
+            type: "string",
+            describe: "Id of the target Kontent.ai environment that should be synced",
+            demandOption: "You need to provide the environmentId of the Kontent.ai to be synced",
+            alias: "e",
+          })
+          .option("apiKey", {
+            type: "string",
+            describe: "Management API key of target Kontent.ai project",
+            demandOption: "You need to provide a Management API key for the given Kontent.ai environment.",
+            alias: "k",
+          })
+          .option("fileName", {
+            type: "string",
+            describe: "Name of the json file with content model",
+            alias: "f",
+          }),
+      handler: args => generateModel(args),
+    },
+  );
+
+export type SyncParams =
+  & Readonly<{
+    environmentId: string;
+    apiKey: string;
+    fileName?: string;
+  }>
+  & LogOptions;
+
+export const generateModel = (params: SyncParams) => {
+  //TODO
+  generateSyncModelToFile(params);
+};

src/commands/sync.ts

@@ -0,0 +1,45 @@
+import { LogOptions } from "../log.js";
+import { RegisterCommand } from "../types/yargs.js";
+
+export const sync: RegisterCommand = yargs =>
+  yargs.command(
+    {
+      command: "sync",
+      describe: "Synchronize content model by model in file",
+      builder: yargs =>
+        yargs
+          .option("fileName", {
+            type: "string",
+            describe: "Name of the json file with content model",
+            demandOption: "You need to provide the filename of the json file to sync content model",
+            alias: "f",
+          })
+          .option("environmentId", {
+            type: "string",
+            describe: "Id of the target Kontent.ai environment that should be synced",
+            demandOption: "You need to provide the environmentId of the Kontent.ai to be synced",
+            alias: "e",
+          })
+          .option("apiKey", {
+            type: "string",
+            describe: "Management API key of target Kontent.ai project",
+            demandOption: "You need to provide a Management API key for the given Kontent.ai environment.",
+            alias: "k",
+          }),
+      handler: args => syncContentModel(args),
+    },
+  );
+
+export type SyncParams =
+  & Readonly<{
+    environmentId: string;
+    fileName: string;
+    apiKey: string;
+  }>
+  & LogOptions;
+
+export const syncContentModel = (params: SyncParams) => {
+  //TODO
+  params as never;
+};
+

src/modules/sync/diff.ts

@@ -0,0 +1,13 @@
+import { ManagementClient } from "@kontent-ai/management-sdk"
+
+type DiffConfig = DiffOptions
+
+type DiffOptions = {
+    filname: string
+}
+
+export const diff = (client: ManagementClient, config: DiffConfig) => {
+    //TODO
+    client as never;
+    config as never;
+}

src/modules/sync/generateSyncModel.ts

@@ -0,0 +1,37 @@
+import { ManagementClient } from "@kontent-ai/management-sdk";
+
+import { ManagementClientBaseOptions } from "../../types/managementClient.js";
+import { generateContentTypeModel } from "./modelGenerators/contentTypes.js";
+import { generateContentTypeSnippetsModel } from "./modelGenerators/contentTypeSnippets.js";
+import { generateTaxonomyGroupsModel } from "./modelGenerators/taxonomyGroups.js";
+
+type GetModelConfig = ManagementClientBaseOptions & GetModelOptions
+
+type GetModelOptions = {
+    filename?: string
+}
+
+export const generateSyncModelToFile = (config: GetModelConfig) => {
+  /**
+   * This function should create the file dateTime-environmentId.json (if other name not specified)
+   * This file contains the content model from the given environmentId (you can use the type fileContentModel).
+   * The internalIds should be replaced by codenames.
+   * Unnecesary fields for syncing like lastModified should be removed.
+   * The tool might add comment about the datetime and tool's version.
+   */
+
+  //TODO
+  const client = new ManagementClient({
+    environmentId: config.environmentId,
+    apiKey: config.apiKey
+  })
+
+  const contentTypeModel = generateContentTypeModel(client);
+  const contentTypeSnippetModel = generateContentTypeSnippetsModel(client);
+  const taxonomyGroupsModel = generateTaxonomyGroupsModel(client);
+
+  contentTypeModel as never;
+  contentTypeSnippetModel as never;
+  taxonomyGroupsModel as never;
+
+}

src/modules/sync/modelGenerators/contentTypeSnippets.ts

@@ -0,0 +1,10 @@
+import { ManagementClient } from "@kontent-ai/management-sdk";
+
+import { ContentTypeSnippetsContract } from "../types/fileContentModel.js";
+
+export const generateContentTypeSnippetsModel =  (client: ManagementClient): ContentTypeSnippetsContract  => {
+    //TODO
+    client as never;
+
+    return {} as ContentTypeSnippetsContract;
+}

src/modules/sync/modelGenerators/contentTypes.ts

@@ -0,0 +1,10 @@
+import { ManagementClient } from "@kontent-ai/management-sdk";
+
+import { ContentTypeContract } from "../types/fileContentModel.js";
+
+export const generateContentTypeModel = (client: ManagementClient): ContentTypeContract => {
+    //TODO
+    client as never;
+
+    return {} as ContentTypeContract;
+}

src/modules/sync/modelGenerators/taxonomyGroups.ts

@@ -0,0 +1,10 @@
+import { ManagementClient } from "@kontent-ai/management-sdk";
+
+import { TaxonomyContract } from "../types/fileContentModel.js";
+
+export const generateTaxonomyGroupsModel = (client: ManagementClient): TaxonomyContract => {
+    //TODO
+    client as never;
+
+    return {} as TaxonomyContract
+}

src/modules/sync/sync.ts

@@ -0,0 +1,9 @@
+import { ManagementClient } from "@kontent-ai/management-sdk";
+
+import { DiffModel } from "./types/diffModel.js";
+
+export const sync = (client: ManagementClient, diff: DiffModel) => {
+    //TODO
+    diff as never;
+    client as never;
+}

src/modules/sync/types/diffModel.ts

@@ -0,0 +1,26 @@
+import { ContentTypeModels, ContentTypeSnippetModels, TaxonomyModels } from "@kontent-ai/management-sdk";
+
+import { RequiredCodename } from "../../../utils/types.js";
+
+type Codename = string;
+
+type DiffObject<A, U> = Readonly<{
+  added: ReadonlyArray<A>;
+  updated: ReadonlyMap<Codename, ReadonlyArray<U>>;
+  deleted: ReadonlyArray<Codename>;
+}>;
+
+export type DiffModel = {
+  taxonomyGroups: DiffObject<
+    RequiredCodename<TaxonomyModels.IAddTaxonomyRequestModel>,
+    TaxonomyModels.IModifyTaxonomyData
+  >;
+  contentTypeSnippets: DiffObject<
+    RequiredCodename<ContentTypeSnippetModels.IAddContentTypeSnippetData>,
+    ContentTypeSnippetModels.IModifyContentTypeSnippetData
+  >;
+  contentTypes: DiffObject<
+    RequiredCodename<ContentTypeModels.IAddContentTypeData>,
+    ContentTypeModels.IModifyContentTypeData
+  >;
+};

src/modules/sync/types/fileContentModel.ts

@@ -0,0 +1,28 @@
+import {
+  ContentTypeContracts,
+  ContentTypeSnippetContracts,
+  ElementContracts,
+  TaxonomyContracts,
+} from "@kontent-ai/management-sdk";
+
+import { CodenameReference, FixReferences } from "../../../utils/types.js";
+
+export type TaxonomyContract = Omit<TaxonomyContracts.ITaxonomyContract, "id" | "last_modified" | "codename" | "terms"> & {
+  codename: string;
+  terms: TaxonomyContract[];
+};
+
+export type ContentTypeSnippetsContract =
+  & Omit<ContentTypeSnippetContracts.IContentTypeSnippetContract, "id" | "codename" | "last_modified" | "elements">
+  & { codename: string; elements: FixReferences<ElementContracts.IContentItemElementContract, CodenameReference>[] };
+
+export type ContentTypeContract =
+  & Omit<ContentTypeContracts.IContentTypeContract, "id" | "codename" | "last_modified" | "elements">
+  & { codename: string; elements: FixReferences<ElementContracts.IContentItemElementContract, CodenameReference>[] };
+
+export type FileContentModel = {
+  taxonomyGroups: ReadonlyArray<TaxonomyContract>;
+  contentTypeSnippets: ReadonlyArray<ContentTypeSnippetsContract>;
+  contentTypes: ReadonlyArray<ContentTypeContract>;
+};
+

src/modules/sync/utils/patchOperations.ts

@@ -0,0 +1,11 @@
+//TODO: This file is justa suggestion. Feel free to come up with your idea :)
+
+export const handleName = (name: string) => ({
+    op : 'replace',
+    path: '/name',
+    value: name
+})
+
+export const contentTypePropertyHandlers = {
+    name: handleName
+}

src/types/managementClient.ts

@@ -0,0 +1,4 @@
+export type ManagementClientBaseOptions = {
+    environmentId: string,
+    apiKey: string
+}

src/utils/types.ts

@@ -4,20 +4,22 @@ export type MapValues<Map extends ReadonlyMap<unknown, unknown>> = Map extends R
   : never;
 
 export type IdReference = Readonly<{ id: string }>;
+export type CodenameReference = Readonly<{ codename: string }>;
 
 /**
  * Use this to replace inaccurate references for better ones in SDK types returned from MAPI.
  *
  * @example FixReferences<LanguageVariantContracts.ILanguageVariantModel>
  */
-export type FixReferences<T> = T extends object ? {
+export type FixReferences<T, R extends IdReference | CodenameReference = IdReference> = T extends object ? {
     [K in keyof T]: T[K] extends SharedContracts.IReferenceObjectContract
-      ? SharedContracts.IReferenceObjectContract extends T[K] ? IdReference : FixReferences<T[K]>
-      : FixReferences<T[K]>;
+      ? SharedContracts.IReferenceObjectContract extends T[K] ? R : FixReferences<T[K], R>
+      : FixReferences<T[K], R>;
   }
   : T;
 
 export type RequiredId<T extends { [key in "id"]?: string }> = Replace<T, "id", string>;
+export type RequiredCodename<T extends { [key in "codename"]?: string }> = Replace<T, "codename", string>;
 
 export type Replace<T, Key extends keyof T, NewValue, IsOptional extends boolean = false> =
   & Omit<T, Key>