@tanglemedia/directus-collection-testimonial 0.0.1

package/migrations/20260301A-tngl_testimonial-~-add-testimonial-table.mjs

@@ -0,0 +1,39 @@
+const COLLECTION_NAME = "tngl_testimonial";
+
+export async function up(knex) {
+  // if table exists, do not proceed with migration
+  if (await knex.schema.hasTable(COLLECTION_NAME)) {
+    return;
+  }
+
+  // create table
+  await knex.schema.createTable(COLLECTION_NAME, (table) => {
+    table.increments("id").unsigned().notNullable();
+
+    // default fields
+    table.integer("sort").nullable();
+    table.string("status", 255).notNullable().defaultTo("draft");
+
+    // accountability fields
+    table.specificType("user_created", "char(36)").nullable();
+    table.specificType("user_updated", "char(36)").nullable();
+    table.timestamp("date_created").nullable();
+    table.timestamp("date_updated").nullable();
+
+    // custom fields
+    table.string("author", 255).nullable();
+    table.text("comment").nullable();
+    table.date("comment_date").nullable();
+
+    table.primary(["id"]);
+
+    // relationships
+    table.foreign("user_created").references("id").inTable("directus_users");
+    table.foreign("user_updated").references("id").inTable("directus_users");
+  });
+}
+
+export async function down(knex) {
+  // drop table
+  await knex.schema.dropTableIfExists(COLLECTION_NAME);
+}

package/migrations/20260301B-tngl_testimonial-~-register-testimonial-collection-and-fields.mjs

@@ -0,0 +1,128 @@
+import { getBasicCollectionFields } from "./helpers/fields.mjs";
+
+const COLLECTION_NAME = "tngl_testimonial";
+
+const COLLECTION_INSERTS = [
+	{
+		accountability: "all",
+		archive_app_filter: true,
+		archive_field: "status",
+		archive_value: "archived",
+		collapse: "open",
+		collection: COLLECTION_NAME,
+		color: null,
+		display_template: "{{status}}  {{comment}}",
+		group: null,
+		hidden: false,
+		icon: "comment",
+		item_duplication_fields: null,
+		note: null,
+		preview_url: null,
+		singleton: false,
+		sort: null,
+		sort_field: "sort",
+		unarchive_value: "draft",
+		versioning: false,
+		translations: JSON.stringify([
+			{
+				language: "en-US",
+				translation: "Testimonials",
+			},
+			{
+				language: "en-CA",
+				translation: "Testimonials",
+			},
+		]),
+	},
+];
+const FIELD_INSERTS = [
+	...getBasicCollectionFields(COLLECTION_NAME),
+	{
+		collection: COLLECTION_NAME,
+		conditions: null,
+		display: null,
+		display_options: null,
+		field: "author",
+		group: null,
+		hidden: false,
+		interface: "input",
+		note: null,
+		options: null,
+		readonly: false,
+		required: false,
+		sort: 8,
+		special: null,
+		translations: null,
+		validation: null,
+		validation_message: null,
+		width: "full",
+	},
+	{
+		collection: COLLECTION_NAME,
+		conditions: null,
+		display: null,
+		display_options: null,
+		field: "comment",
+		group: null,
+		hidden: false,
+		interface: "input-multiline",
+		note: null,
+		options: null,
+		readonly: false,
+		required: false,
+		sort: 9,
+		special: null,
+		translations: null,
+		validation: null,
+		validation_message: null,
+		width: "full",
+	},
+	{
+		collection: COLLECTION_NAME,
+		conditions: null,
+		display: "datetime",
+		display_options: JSON.stringify({}),
+		field: "comment_date",
+		group: null,
+		hidden: false,
+		interface: "datetime",
+		note: null,
+		options: JSON.stringify({
+			use24: false,
+		}),
+		readonly: false,
+		required: false,
+		sort: 10,
+		special: null,
+		translations: null,
+		validation: null,
+		validation_message: null,
+		width: "full",
+	},
+];
+
+export async function up(knex) {
+	// if row exists in directus_collections table, do not proceed with migration
+	const collectionExists = await knex("directus_collections")
+		.select("collection")
+		.where("collection", COLLECTION_NAME)
+		.first();
+
+	// register table into `directus_collections` table
+	// for full list of directus_collections properties, refer to: https://docs.directus.io/reference/system/collections.html
+	if (!collectionExists) {
+		await knex("directus_collections").insert(COLLECTION_INSERTS);
+	}
+
+	// register fields into `directus_fields` table
+	// for full list of directus_fields properties, refer to: https://docs.directus.io/reference/system/fields.html
+	await knex("directus_fields").insert(FIELD_INSERTS);
+}
+
+export async function down(knex) {
+	// remove associated data from directus_fields table
+	await knex("directus_fields").where("collection", COLLECTION_NAME).del();
+
+	// remove associated data from directus_collections table
+	await knex("directus_collections").where("collection", COLLECTION_NAME).del();
+}

package/migrations/20260301C-tngl_testimonial-~-set-permissions.mjs

@@ -0,0 +1,10 @@
+import { createPermission } from "./helpers/permission.mjs";
+
+export async function up(knex) {
+	await createPermission(knex, "tngl_testimonial", "Website", ["read"]);
+	await createPermission(knex, "tngl_testimonial", "Staff", ["create", "read", "update", "delete"]);
+}
+
+export async function down(knex) {
+	// No rollback needed
+}

package/migrations/20260301D-tngl_testimonial-~-set-default-presets.mjs

@@ -0,0 +1,47 @@
+const COLLECTION_NAME = "tngl_testimonial";
+
+// preset that applies to any user or role
+const PRESETS = [
+	{
+		bookmark: null,
+		collection: "tngl_testimonial",
+		color: null,
+		filter: null,
+		icon: "bookmark",
+		layout: null,
+		layout_options: JSON.stringify({
+			tabular: {
+				widths: {
+					author: 192.6171875,
+					status: 107.09375,
+					comment: 492.5572509765625,
+					comment_date: 209.22393798828125,
+				},
+			},
+		}),
+		layout_query: JSON.stringify({
+			tabular: {
+				page: 1,
+				fields: ["status", "comment_date", "author", "comment"],
+			},
+		}),
+		refresh_interval: null,
+		role: null,
+		search: null,
+	},
+];
+
+export async function up(knex) {
+	await knex("directus_presets").insert(PRESETS);
+}
+
+export async function down(knex) {
+	await knex("directus_presets")
+		.where({
+			user: null,
+			role: null,
+			bookmark: null,
+			collection: COLLECTION_NAME,
+		})
+		.del();
+}

package/migrations/20260301E-tngl_testimonial-~-add-initial-content.mjs

@@ -0,0 +1,33 @@
+export async function up(knex) {
+	await knex("tngl_testimonial").insert([
+		{
+			sort: 1,
+			status: "published",
+			date_created: knex.fn.now(3),
+			date_updated: knex.fn.now(3),
+			author: "John Smith",
+			comment: "We had a great experience from beginning to end. Communication was clear, deadlines were met, and the attention to detail really stood out. It’s rare to find a team that combines professionalism with such a genuine commitment to delivering great results. We would gladly work with them again.",
+			comment_date: knex.fn.now(3),
+		},
+		{
+			sort: 2,
+			status: "published",
+			date_created: knex.fn.now(3),
+			date_updated: knex.fn.now(3),
+			author: "Jane Smith",
+			comment: "Working with this team was a fantastic experience. They were professional, responsive, and truly understood what we needed. The final result exceeded our expectations, and the entire process was smooth from start to finish. I would absolutely recommend their services to anyone looking for quality work and reliable support.",
+			comment_date: knex.fn.now(3),
+		},
+	]);
+}
+
+export async function down(knex) {
+	await knex("directus_presets")
+		.where({
+			user: null,
+			role: null,
+			bookmark: null,
+			collection: COLLECTION_NAME,
+		})
+		.del();
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@tanglemedia/directus-collection-testimonial",
+  "description": "Installs the Testimonial Collection to your Directus project.",
+  "author": {
+    "name": "Tangle Media, Inc."
+  },
+  "license": "MIT",
+  "icon": "extension",
+  "version": "0.0.1",
+  "keywords": [
+    "directus",
+    "directus-extension",
+    "directus-extension-hook",
+    "testimonial-collection",
+    "directus-collection",
+    "collection"
+  ],
+  "files": [
+    "dist",
+    "src",
+    "migrations",
+    "scripts",
+    "docs"
+  ],
+  "directus:extension": {
+    "type": "hook",
+    "path": "dist/index.js",
+    "source": "src/index.js",
+    "host": "^10.10.1 || ^11.0.0",
+    "sandbox": {
+      "enabled": false,
+      "requestedScopes": {
+        "log": {}
+      }
+    }
+  },
+  "devDependencies": {
+    "@directus/extensions-sdk": "13.0.0",
+    "@types/node": "^22.13.0",
+    "typescript": "^5.7.3"
+  },
+  "scripts": {
+    "build": "directus-extension build",
+    "dev": "directus-extension build -w --no-minify",
+    "link": "directus-extension link"
+  }
+}

package/src/index.js

@@ -0,0 +1,8 @@
+const { defineHook } = require("@directus/extensions-sdk");
+const moveMigrationScripts = require("./shared/utility/migrations");
+
+module.exports = defineHook(
+  async ({ action, init }, { services, database, getSchema, logger }) => {
+    await moveMigrationScripts(logger);
+  },
+);

package/src/shared/utility/migrations.js

@@ -0,0 +1,30 @@
+const { exec } = require("child_process");
+const { promisify } = require("util");
+const path = require("node:path");
+const execPromise = promisify(exec);
+
+const moveMigrationScripts = async (logger) => {
+  const ROOT = process.cwd();
+  const EXTENSION_PATH = __dirname;
+
+  let migrationSrcPath = EXTENSION_PATH.split("/");
+  migrationSrcPath.pop();
+  migrationSrcPath.push("migrations");
+  migrationSrcPath = path.join("/", ...migrationSrcPath);
+
+  let migrationDestPath = ROOT.split("/");
+  migrationDestPath.push("migrations");
+  migrationDestPath = path.join("/", ...migrationDestPath);
+
+  // create destination folder
+  let { stdout, stderr } = await execPromise(`mkdir -p ${migrationDestPath}`);
+  if (stderr) return;
+
+  // copy files
+  ({ stdout, stderr } = await execPromise(
+    `cp -r ${migrationSrcPath}/* ${migrationDestPath}`,
+  ));
+  if (stderr) return;
+};
+
+module.exports = moveMigrationScripts;