@mftc/nuxt-launch-darkly

!GitHub Workflow Status !npm !version !NPM

> A Nuxt module for interacting with the Launch Darkly SDK

_This module is under heavy development so expect breaking changes._

Features

- 🌈 Composable for Composition API support
- ⚡️ Adds REST endpoints for custom integrations
- 💯 Nuxt 3

Setup

1. Install @mftc/nuxt-launch-darkly

``bash
npm install @mftc/nuxt-launch-darkly or # yarn add @mftc/nuxt-launch-darkly
`

2. Add it as a buildModule in nuxt.config.ts and configure it with your Launch Darkly server-side SDK key.
The sdkKey should go in privateRuntimeConfig since the Launch Darkly SDK Key needs to be kept private.

`js
export default defineNuxtConfig({
buildModules: ['@mftc/nuxt-launch-darkly'],
privateRuntimeConfig: {
launchDarkly: {
sdkKey: process.env.LD_SDK_KEY
}
},
// optional
launchDarkly: {
apiPath: '/api/launch-darkly', // customisable api path: default '/api/launch-darkly'
logLevel: 'info' // 'debug' | 'info' | 'warn' | 'error' | 'none': default 'info'
}
})
`

Usage

#### 🧩 Composable

`ts

`

#### 🌀 REST Endpoint

This module exposes the REST endpoints that are used by the composable internally. This could be useful if you wanted to get all the flags on app init and save them to the store for example.

The module exposes two endpoints:

1. ${apiPath}/flags
1. ${apiPath}/user

Query Parameters:

`ts
key: string // required
email?: string
firstName?: string
lastName?: string
`

`html
?key=xxx-xxx&email=user@domain.com&firstName=Jane&lastName=Doe
`

These query parameters are valid for all requests. key is the only required parameter.

The API path will default to /api/launch-darkly but you can set a custom path in the launchDarkly config in nuxt.config.ts. See the setup section for details

#### /flags

##### Get all variants

LDClient.allFlagsState

`html
GET /api/launch-darkly/flags?{query-params}
`

##### Get single variant

LDClient.variation

`html
GET /api/launch-darkly/flags/flag-key?{query-params}
`

##### Get single variant with detail

LDClient.variationDetail

`html
GET /api/launch-darkly/flags/flag-key/detail?{query-params}
`

#### /user

##### Identify

LDClient.identify

`html
GET /api/launch-darkly/user/identify?{query-params}
`

##### Track

LDClient.track

`bash
curl -X POST "/api/launch-darkly/user/track?{query-params}" -H "Content-Type: application/json" -d '{"myKey":{"arr":[1,"foo"],"nested":{"a":1,"b":{"key":"bar"}}},"metricValue":1}'
`

Development

- Create a .env file in the playground directory and add these variables:

`bash
LD_SDK_KEY= # with the value of a Launch Darkly server-side SDK Key.
EMAIL= # email address of a user captured by LD (optional)
USER_KEY= # the unique key of a user captured by LD
FIRST_NAME= # first name
LAST_NAME= # last name
`

- Run npm run prepare:playground to generate type stubs.
- Use npm run play` to start playground in development mode.