# ssb-index-feeds

> Keep an index feed up-to-date with the content feed

Latest version **0.10.2** (published 2022-10-20) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install ssb-index-feeds
pnpm add ssb-index-feeds
yarn add ssb-index-feeds
bun add ssb-index-feeds
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.2 |
| Published | 2022-10-20 |
| First published | 2022-09-16 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 47.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Andre 'Staltz' Medeiros |
| Maintainers | staltz |

## Links

- npm: https://www.npmjs.com/package/ssb-index-feeds
- Repository: https://github.com/ssbc/ssb-index-feeds
- Issues: https://github.com/ssbc/ssb-index-feeds/issues
- npm.io page: https://npm.io/package/ssb-index-feeds

## Dependencies (10)

- [debug](https://npm.io/package/debug.md) ^4.3.2
- [ssb-db2](https://npm.io/package/ssb-db2.md) >=5
- [ssb-ref](https://npm.io/package/ssb-ref.md) ^2.16.0
- [pull-cat](https://npm.io/package/pull-cat.md) ^1.1.11
- [ssb-keys](https://npm.io/package/ssb-keys.md) >=8
- [ssb-uri2](https://npm.io/package/ssb-uri2.md) ^2.1.0
- [pull-stream](https://npm.io/package/pull-stream.md) ^3.6.14
- [ssb-classic](https://npm.io/package/ssb-classic.md) ^1.0.3
- [ssb-subset-ql](https://npm.io/package/ssb-subset-ql.md) ^1.0.0
- [is-canonical-base64](https://npm.io/package/is-canonical-base64.md) ^1.1.1

## Recent versions

- 0.10.2 (latest) — 2022-10-20
- 0.10.1 — 2022-10-12
- 0.10.0 — 2022-10-07
- 0.9.0 — 2022-09-16

## README

<!--
SPDX-FileCopyrightText: 2021 Andre 'Staltz' Medeiros

SPDX-License-Identifier: CC0-1.0
-->

# ssb-index-feeds

A secret-stack plugin that uses [ssb-meta-feeds](https://github.com/ssbc/ssb-meta-feeds)
to create and update [index feeds](https://github.com/ssbc/ssb-secure-partial-replication-spec#indexes).

Also contains a [feed format](https://github.com/ssbc/ssb-feed-format) `indexed-v1`
under `./format.js`.

## Installation

**Prerequisites:**

- Requires **Node.js 10** or higher
- Requires `ssb-db2` version 5.0 or higher
- Requires `ssb-meta-feeds`

```
npm install --save ssb-index-feeds
```

Add this plugin like this:

```diff
 const sbot = SecretStack({ appKey: caps.shs })
     .use(require('ssb-db2'))
     .use(require('ssb-meta-feeds'))
+    .use(require('ssb-index-feeds'))
     // ...
```

## Example usage

There is one primary API this plugin provides: `start()`. You pass it a
`ssb-ql-0` query and it will detect whether it needs to create an index feed for
that query, or update an existing index feed.

```js
sbot.indexFeeds.start({ author: sbot.id, type: 'vote', private: false }, (err, index) => {
  console.log('The index feed is ' + index.subfeed)
})
```

From this point onwards, whenever the query gets more results (as the log gets
appended), the index feed will be automatically written to.

To stop the index feed from being written to, use `stop()` with the same query
input.

## API

### `sbot.indexFeeds.start(query, cb)` (async)

_Begins updating an index feed for the given query_

`query` must be an `ssb-ql-0` query, either as stringified JSON or as an object.

The callback `cb` will be called right before the index feed would be written
to. If there are no updates to be written on the index feed, this callback will
anyway be called. The 1st argument is the possible error, and the 2nd argument
is the "subfeed object" containing details on the index feed that matches the
query. The subfeed object has the shape `{ feedpurpose, subfeed, keys, metadata }`,
the same shape as returned by `ssb-meta-feeds` APIs.

### `sbot.indexFeeds.doneOld(query, cb)` (async)

_Informs you when the index feed for the given query has processed the existing database_

`query` must be an `ssb-ql-0` query, either as stringified JSON or as an object.

The callback `cb` will be called as soon as the *writing* of the index feed has
finished processing all "old" messages on the log. The callback is called with
zero arguments.

### `sbot.indexFeeds.stop(query)` (sync)

_Cancels the updating of the index feed for the given query, if it had started_

`query` must be an `ssb-ql-0` query, either as stringified JSON or as an object.

Does not return anything as a response.

## Configuration

Some behaviors of this module can be configured by the user or by application
code through the conventional [ssb-config](https://github.com/ssbc/ssb-config)
object. The possible options are listed below:

```js
{
  indexFeeds: {
    /**
     * If `autostart` is defined as an array, it informs ssb-index-feeds to
     * automatically call `start()` with each of the array items, as soon as
     * this plugin is initialized.
     *
     * The array items are just ssb-ql-0 objects, except without the `author`
     * property, because that one will always be implicitly equal to `sbot.id`.
     */
    autostart: [
      { type: 'vote', private: false },
      { type: 'post', private: false },
      { type: null, private: true },
    ]
  }
}
```

## License

LGPL-3.0

---
_Source: https://npm.io/package/ssb-index-feeds · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._