npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

umzug-contentful

v1.1.5

Published

Umzug custom storage provider that stores migration data in Contentful

Downloads

158

Readme

Umzug Contentful

Umzug custom storage provider that stores migration data in Contentful.

Umzug is the migration tool that powers sequelize. Umzug Contentful provides a Storage provider for umzug that allows your migration metadata to be stored in Contentful so that you can easily run stateful migrations on your Contentful data, probably using contentful-migration.

Installation

npm install -D umzug umzug-contentful

Usage

import { Umzug } from "umzug";
import { ContentfulStorage } from "umzug-contentful";

const umzug = new Umzug({
  // ... other options
  storage: new ContentfulStorage({
    spaceId: "abc123",
    environmentId: "master",
    contentfulManagementToken: "my-secret-token",
  }),
});

Refer to the umzug documentation for information on how to use umzug.

Options

The ContentfulStorage constructor takes one parameter, of type UmzugContentfulOptions.

option | type | required | default | description --- |--- |--- |--- |--- spaceId | string | true | | Contentful Space ID environmentId | string | true | | Contentful Environment ID (use master if you're not sure what this means) contentfulManagementToken | string | true | | Access token for Contentful's Management API locale | string | false |en-US | Locale to store data against, must be one you've configured migrationEntryId | string | false | umzugMigrationDataEntry | ID of the entry migration data will be stored in migrationContentTypeId | string | false | umzugMigrationData | ID of the content type migration data will be stored against

Use with contentful-migration

You'll likely want to avoid boilerplate in your individual migration scripts. You can do this by passing a runMigration function to contentful-migration via the umzug context:

import { Umzug } from "umzug";
import { ContentfulStorage } from "umzug-contentful";
import { runMigration, MigrationFunction } from "contentful-migration";
import * as fs from "fs";

async function migrate(migrationFunction: MigrationFunction): Promise<void> {
  await runMigration({
    migrationFunction,
    spaceId: "abc123",
    environmentId: "master",
    contentfulManagementToken: "my-secret-token",
  });
}

const umzug = new Umzug({
  // ... other options
  context: { migrate }, // do not pass a function as the context, because umzug will call it instead of passing it through
});

if (require.main === module) {
  void umzug.runAsCLI();
}

And then in your migration script:

export const up = async ({ context }) => {
  await context.migrate((migration) => {
    // write your migration
  });
}

License

MIT