nuxt-google-sheets-import 0.1.4

package/dist/runtime/components/GoogleSheetsImportSchemaGuide.vue

@@ -0,0 +1,213 @@
+<script setup>
+import { computed, onMounted, ref, watch } from "vue";
+import { useGoogleSheetsImport } from "../composables/useGoogleSheetsImport";
+const props = defineProps({
+  initialSchema: { type: String, required: false, default: "" }
+});
+const { getSchemaColumns } = useGoogleSheetsImport();
+const toast = useToast();
+const selectedSchema = ref("");
+const availableSchemas = ref([]);
+const columns = ref([]);
+const collectionType = ref("unknown");
+const pageOverrideColumns = ref([]);
+const status = ref("idle");
+const error = ref("");
+const schemaOptions = computed(() => availableSchemas.value.map((schema) => ({
+  label: schema,
+  value: schema
+})));
+async function loadSchemas() {
+  status.value = "pending";
+  error.value = "";
+  try {
+    const response = await getSchemaColumns();
+    availableSchemas.value = response.schemas;
+    selectedSchema.value = props.initialSchema && response.schemas.includes(props.initialSchema) ? props.initialSchema : response.schemas[0] ?? "";
+    status.value = "success";
+  } catch (cause) {
+    status.value = "error";
+    error.value = cause instanceof Error ? cause.message : "Could not load schema list.";
+  }
+}
+async function loadColumns(schema) {
+  if (!schema) {
+    columns.value = [];
+    return;
+  }
+  status.value = "pending";
+  error.value = "";
+  try {
+    const response = await getSchemaColumns(schema);
+    columns.value = response.columns;
+    collectionType.value = response.collectionType;
+    pageOverrideColumns.value = response.pageOverrideColumns;
+    status.value = "success";
+  } catch (cause) {
+    columns.value = [];
+    collectionType.value = "unknown";
+    pageOverrideColumns.value = [];
+    status.value = "error";
+    error.value = cause instanceof Error ? cause.message : "Could not load schema columns.";
+  }
+}
+watch(selectedSchema, async (schema) => {
+  await loadColumns(schema);
+});
+onMounted(async () => {
+  await loadSchemas();
+  if (selectedSchema.value) {
+    await loadColumns(selectedSchema.value);
+  }
+});
+function copyColumns() {
+  const content = columns.value.join("\n");
+  if (!content) {
+    return;
+  }
+  navigator.clipboard.writeText(content);
+  toast.add({
+    title: "Copied",
+    description: "Column names copied to clipboard.",
+    color: "success"
+  });
+}
+function csvRow(values) {
+  return values.map((value) => {
+    const escaped = value.replaceAll('"', '""');
+    return `"${escaped}"`;
+  }).join(",");
+}
+function copyColumnsCsv() {
+  const content = csvRow(columns.value);
+  if (!content) {
+    return;
+  }
+  navigator.clipboard.writeText(content);
+  toast.add({
+    title: "Copied",
+    description: "Column names copied as a CSV row.",
+    color: "success"
+  });
+}
+function copyPageOverrideColumns() {
+  const content = pageOverrideColumns.value.join("\n");
+  if (!content) {
+    return;
+  }
+  navigator.clipboard.writeText(content);
+  toast.add({
+    title: "Copied",
+    description: "Page override column names copied to clipboard.",
+    color: "success"
+  });
+}
+function copyPageOverrideColumnsCsv() {
+  const content = csvRow(pageOverrideColumns.value);
+  if (!content) {
+    return;
+  }
+  navigator.clipboard.writeText(content);
+  toast.add({
+    title: "Copied",
+    description: "Page override column names copied as a CSV row.",
+    color: "success"
+  });
+}
+</script>
+
+<template>
+  <div class="space-y-4">
+    <UAlert
+      title="Schema column helper"
+      description="Choose a schema to see the expected Google Sheet column names."
+      color="neutral"
+      variant="subtle"
+    />
+
+    <UAlert
+      v-if="error"
+      title="Could not load schema information"
+      :description="error"
+      color="error"
+      variant="subtle"
+    />
+
+    <UFormField
+      label="Collection schema"
+      name="schema"
+      description="Pick the schema you want to import."
+    >
+      <USelect
+        v-model="selectedSchema"
+        :items="schemaOptions"
+        value-key="value"
+        icon="i-heroicons-cube-20-solid"
+        class="w-full max-w-sm"
+        :loading="status === 'pending'"
+      />
+    </UFormField>
+
+    <UAlert
+      v-if="status === 'success' && selectedSchema"
+      title="Expected column names"
+      :description="`Use these exact headers in your Google Sheet for schema: ${selectedSchema}.`"
+      color="neutral"
+      variant="subtle"
+    />
+
+    <div
+      v-if="columns.length"
+      class="space-y-3"
+    >
+      <div class="flex flex-wrap gap-2">
+        <UButton
+          label="Copy column names"
+          icon="i-heroicons-clipboard-document-20-solid"
+          color="neutral"
+          variant="subtle"
+          @click="copyColumns"
+        />
+        <UButton
+          label="Copy as CSV row"
+          icon="i-heroicons-table-cells-20-solid"
+          color="neutral"
+          variant="subtle"
+          @click="copyColumnsCsv"
+        />
+      </div>
+      <pre class="text-xs whitespace-pre-wrap">{{ columns.join("\n") }}</pre>
+
+      <UAlert
+        v-if="collectionType === 'page' && pageOverrideColumns.length"
+        title="Nuxt Content page overrides"
+        description="Optional built-in page fields Nuxt Content adds automatically for page collections."
+        color="neutral"
+        variant="subtle"
+      />
+
+      <div
+        v-if="collectionType === 'page' && pageOverrideColumns.length"
+        class="space-y-3"
+      >
+        <div class="flex flex-wrap gap-2">
+          <UButton
+            label="Copy page override columns"
+            icon="i-heroicons-clipboard-document-list-20-solid"
+            color="neutral"
+            variant="subtle"
+            @click="copyPageOverrideColumns"
+          />
+          <UButton
+            label="Copy overrides as CSV row"
+            icon="i-heroicons-table-cells-20-solid"
+            color="neutral"
+            variant="subtle"
+            @click="copyPageOverrideColumnsCsv"
+          />
+        </div>
+        <pre class="text-xs whitespace-pre-wrap">{{ pageOverrideColumns.join("\n") }}</pre>
+      </div>
+    </div>
+  </div>
+</template>

package/dist/runtime/components/GoogleSheetsImportSchemaGuide.vue.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    initialSchema?: string;
+}
+declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/components/GoogleSheetsImportSource.d.vue.ts

@@ -0,0 +1,9 @@
+interface Props {
+    googleSheets: {
+        id: string;
+        label: string;
+    }[];
+}
+declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/components/GoogleSheetsImportSource.vue

@@ -0,0 +1,127 @@
+<script setup>
+import { z } from "zod";
+const { googleSheets } = defineProps({
+  googleSheets: { type: Array, required: true }
+});
+const toast = useToast();
+const googleSheetSchema = z.object({
+  spreadsheetId: z.string().length(44),
+  sheetTitle: z.string(),
+  range: z.string(),
+  schema: z.string()
+});
+const {
+  source,
+  sourceStatus,
+  sourceError,
+  sheetTitles,
+  upperCaseRange,
+  selectedSheetPreview,
+  canLoadValues,
+  sourceQuery
+} = useGoogleSheetsImportWorkflow();
+watch(sourceStatus, (value) => {
+  if (value === "success") {
+    toast.add({ title: "Success", description: "Google Sheet titles retrieved.", color: "success" });
+  }
+});
+watch(sourceError, (value) => {
+  if (value) {
+    toast.add({
+      title: "Error",
+      description: value,
+      color: "error"
+    });
+  }
+});
+</script>
+
+<template>
+  <div class="space-y-4">
+    <UAlert
+      title="Step 1: Select source sheet"
+      description="Choose a spreadsheet and tab, then confirm range and schema key before loading rows."
+      color="neutral"
+      variant="subtle"
+    />
+
+    <UAlert
+      v-if="sourceError"
+      title="Could not load sheet tabs"
+      :description="sourceError"
+      color="error"
+      variant="subtle"
+    />
+
+    <UForm
+      :state="source"
+      :schema="googleSheetSchema"
+      class="space-y-4"
+    >
+      <UFormField
+        label="Spreadsheet"
+        name="spreadsheetId"
+        description="Select one configured Google Sheet source."
+      >
+        <USelect
+          v-model="source.spreadsheetId"
+          :items="googleSheets"
+          value-key="id"
+          label="Spreadsheet"
+          icon="i-heroicons-document-chart-bar-20-solid"
+          class="w-full max-w-sm"
+          :loading="sourceStatus === 'pending'"
+        />
+      </UFormField>
+
+      <UFormField
+        v-if="sheetTitles.length"
+        label="Sheet tab"
+        name="sheetTitle"
+        description="Tabs are fetched from the selected spreadsheet."
+      >
+        <USelect
+          v-model="source.sheetTitle"
+          :items="sheetTitles"
+          value-key="label"
+          label="Sheet tab"
+          icon="i-heroicons-table-cells-20-solid"
+          class="w-full max-w-sm"
+        />
+      </UFormField>
+
+      <UFormField
+        v-if="source.sheetTitle"
+        label="Range"
+        name="range"
+        :description="selectedSheetPreview ? `Default detected range: ${selectedSheetPreview.range}` : 'Enter Google Sheets A1 range (e.g. A:Z).'"
+      >
+        <UInput
+          v-model="upperCaseRange"
+          label="Range"
+          icon="i-heroicons-arrows-right-left-20-solid"
+          class="w-full max-w-sm"
+        />
+      </UFormField>
+
+      <UFormField
+        v-if="source.range"
+        label="Schema key"
+        name="schema"
+        description="Must match a key in your exported `schemas` map."
+      >
+        <UInput
+          v-model="source.schema"
+          label="Schema key"
+          icon="i-heroicons-cube-20-solid"
+          class="w-full max-w-sm"
+        />
+      </UFormField>
+    </UForm>
+
+    <GoogleSheetsImportExecute
+      v-if="canLoadValues && sourceQuery"
+      :query="sourceQuery"
+    />
+  </div>
+</template>

package/dist/runtime/components/GoogleSheetsImportSource.vue.d.ts

@@ -0,0 +1,9 @@
+interface Props {
+    googleSheets: {
+        id: string;
+        label: string;
+    }[];
+}
+declare const __VLS_export: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/composables/useGoogleSheetsImport.d.ts

@@ -0,0 +1,50 @@
+interface GoogleSheetOption {
+    label: string;
+    range: string;
+}
+interface GetValuesPayload {
+    spreadsheetId: string;
+    sheetTitle: string;
+    range: string;
+    schema: string;
+}
+interface WritePayload {
+    records: Record<string, unknown>[];
+    schema?: string;
+    folder: string;
+    slugKey: string;
+    orderKey?: string;
+    contentDir?: string;
+    outputFormat?: 'frontmatter' | 'json' | 'yaml';
+    overwriteMode?: 'skip' | 'overwrite' | 'overwrite-frontmatter';
+}
+export declare function useGoogleSheetsImport(): {
+    getSheets: (spreadsheetId: string) => Promise<GoogleSheetOption[]>;
+    getValues: (payload: GetValuesPayload) => Promise<{
+        headers: string[];
+        records: Record<string, unknown>[];
+        errors: string[];
+    }>;
+    getCollectionType: (schema: string) => Promise<{
+        collectionType: "page" | "data" | "unknown";
+        baseContentDir: string;
+    }>;
+    getSchemaColumns: (schema?: string) => Promise<{
+        schema: string | null;
+        schemas: string[];
+        columns: string[];
+        collectionType: "page" | "data" | "unknown";
+        pageOverrideColumns: string[];
+    }>;
+    writeFiles: (payload: WritePayload) => Promise<{
+        count: number;
+        logs: string[];
+        contentDir: string;
+        summary: {
+            written: number;
+            overwritten: number;
+            skipped: number;
+        };
+    }>;
+};
+export {};

package/dist/runtime/composables/useGoogleSheetsImport.js

@@ -0,0 +1,40 @@
+import { useRuntimeConfig } from "#imports";
+export function useGoogleSheetsImport() {
+  const config = useRuntimeConfig();
+  const apiBase = config.public.googleSheetsImport?.apiBase ?? "/api/google-sheets-import";
+  const getSheets = async (spreadsheetId) => {
+    const response = await $fetch(`${apiBase}/sheets`, {
+      query: { spreadsheetId }
+    });
+    return response.sheets;
+  };
+  const getValues = async (payload) => {
+    return await $fetch(`${apiBase}/values`, {
+      method: "POST",
+      body: payload
+    });
+  };
+  const getCollectionType = async (schema) => {
+    return await $fetch(`${apiBase}/collection-type`, {
+      query: { schema }
+    });
+  };
+  const getSchemaColumns = async (schema) => {
+    return await $fetch(`${apiBase}/schema-columns`, {
+      query: schema ? { schema } : void 0
+    });
+  };
+  const writeFiles = async (payload) => {
+    return await $fetch(`${apiBase}/write`, {
+      method: "POST",
+      body: payload
+    });
+  };
+  return {
+    getSheets,
+    getValues,
+    getCollectionType,
+    getSchemaColumns,
+    writeFiles
+  };
+}

package/dist/runtime/composables/useGoogleSheetsImportWorkflow.d.ts

@@ -0,0 +1,82 @@
+import type { MaybeRefOrGetter } from 'vue';
+export interface GoogleSheetsImportQuery {
+    spreadsheetId: string;
+    sheetTitle: string;
+    range: string;
+    schema: string;
+}
+interface ImportRecord {
+    [key: string]: unknown;
+}
+interface WorkflowOptions {
+    query?: MaybeRefOrGetter<GoogleSheetsImportQuery>;
+}
+export declare function useGoogleSheetsImportWorkflow(options?: WorkflowOptions): {
+    source: {
+        spreadsheetId?: string | undefined;
+        sheetTitle?: string | undefined;
+        range?: string | undefined;
+        schema?: string | undefined;
+    };
+    sourceStatus: import("vue").Ref<"success" | "error" | "idle" | "pending", "success" | "error" | "idle" | "pending">;
+    sourceError: import("vue").Ref<string, string>;
+    sheetTitles: import("vue").Ref<{
+        label: string;
+        range: string;
+    }[], {
+        label: string;
+        range: string;
+    }[] | {
+        label: string;
+        range: string;
+    }[]>;
+    upperCaseRange: import("vue").WritableComputedRef<string | undefined, string | undefined>;
+    selectedSheetPreview: import("vue").ComputedRef<{
+        label: string;
+        range: string;
+    } | undefined>;
+    sourceQuery: import("vue").ComputedRef<GoogleSheetsImportQuery | null>;
+    activeQuery: import("vue").ComputedRef<GoogleSheetsImportQuery | null>;
+    canLoadValues: import("vue").ComputedRef<boolean>;
+    selectedCollectionType: import("vue").Ref<"page" | "data" | "unknown", "page" | "data" | "unknown">;
+    selectedCollectionTypeStatus: import("vue").Ref<"success" | "error" | "idle" | "pending", "success" | "error" | "idle" | "pending">;
+    resolvedBaseContentDir: import("vue").ComputedRef<any>;
+    resolvedDestinationPath: import("vue").ComputedRef<any>;
+    loadSheetTitles: (spreadsheetId?: string) => Promise<void>;
+    status: import("vue").Ref<"success" | "error" | "idle" | "pending", "success" | "error" | "idle" | "pending">;
+    writeStatus: import("vue").Ref<"success" | "error" | "idle" | "pending", "success" | "error" | "idle" | "pending">;
+    importError: import("vue").Ref<string, string>;
+    writeError: import("vue").Ref<string, string>;
+    writeSummary: import("vue").Ref<{
+        written: number;
+        overwritten: number;
+        skipped: number;
+    }, {
+        written: number;
+        overwritten: number;
+        skipped: number;
+    } | {
+        written: number;
+        overwritten: number;
+        skipped: number;
+    }>;
+    values: import("vue").Ref<ImportRecord[], ImportRecord[]>;
+    validationErrors: import("vue").Ref<string[], string[]>;
+    logs: import("vue").Ref<string[], string[]>;
+    writeFile: {
+        folder: string;
+        slug: string | undefined;
+        order: string | undefined;
+        outputFormat: "frontmatter" | "json" | "yaml";
+        overwriteMode: "skip" | "overwrite" | "overwrite-frontmatter";
+    };
+    columnList: import("vue").ComputedRef<string[]>;
+    productsLength: import("vue").ComputedRef<number>;
+    logsLength: import("vue").ComputedRef<number>;
+    canWrite: import("vue").ComputedRef<boolean>;
+    previewRows: import("vue").ComputedRef<ImportRecord[]>;
+    shownValidationErrors: import("vue").ComputedRef<string[]>;
+    loadValues: (queryArg?: GoogleSheetsImportQuery) => Promise<void>;
+    writeValues: () => Promise<void>;
+};
+export {};