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

@belomonte/ngx-parody-api

v0.1.2

Published

> Matthew 5 > > [43] Ye have heard that it hath been said, Thou shalt love thy neighbour, and hate thine enemy. [44] But I say unto you, Love your enemies, bless them that curse you, do good to them that hate you, and pray for them which despitefully use

Downloads

86

Readme

Matthew 5

[43] Ye have heard that it hath been said, Thou shalt love thy neighbour, and hate thine enemy. [44] But I say unto you, Love your enemies, bless them that curse you, do good to them that hate you, and pray for them which despitefully use you, and persecute you; [45] that ye may be the children of your Father which is in heaven: for he maketh his sun to rise on the evil and on the good, and sendeth rain on the just and on the unjust.

Parody Api

If you code using this lib you automatically become a cypherpunk.

Features of each parody project

Parody family

Parody Projects

Parody projects are jokes in the form of fully functional clients nostr.

I'm still going to tell a lot of jokes, all algorithms with nostr that allow these clients to perform their respective social network interactions will be centralized in this library.

Many will say that it is just a work of plagiarism and that there is no joke. If you do not understand humor and do not want to acquire a joke, do not interfere with my business.

Warning

In release 1.x.x this package will include @belomonte/nostr-ngx dependency, but 0.x.x will be used while @belomonte/nostr-ngx is not released. @belomonte/nostr-ngx will bring angular services to solve pool questions like relay routing, signing, cache for events and profile, deep kinds and interfaces and media uploading.

@belomonte/nostr-ngx will bring an extended version of NPool and it will read user configuration from his own storages structures, by using this package you must understand that means bring @belomonte/nostr-ngx basis archicture to your project, having @belomonte/nostr-ngx your project will be available to use @belomonte/nostr-gui-ngx, with some predefined components to allow user customize his configurations and other common screens that can be used in a nostr app.

The packages @belomonte/nostr-ngx, @belomonte/nostr-gui-ngx and @belomonte/ngx-parody-api are part of the same porpouse: bring to angular the classic social networks feature using nostr. At first, they will be just the reusable things from Twitter Parody, but there are plans to other parody projects and these classic social network features will be centralized in these libraries.

| Library | Release | Porpouse | |-------------|-------------|-------------| | @belomonte/nostr-ngx | Not released | Services to deal with nostr, it bring overridable taken decisions, allowing you override services to customize core behaviors | | @belomonte/nostr-gui-ngx | Not released | Read-to-use components to allow user set his configs, choose profile and signer, but also publish note, chat | | @belomonte/ngx-parody-api | Released | Classic social network features that require algorithms with a higher level of complexity to be established |

Installing

npm install @belomonte/ngx-parody-api --save

@nostrify/nostrify is a dependecy from jsr registry, you may need add this dependecy like this:

npx jsr add @nostrify/nostrify

Updating

ng update in angular cli 18 or lower launches error when need update dependencies from registries different from npm either with .npmrc file in the project, so, if you need to update your project you may have to update this package "manually" by running this command again.

How To Use

Configure

The only available social network feature in this @belomonte/ngx-parody-api version is the Talk to Stranger feature from Omeglestr.

You must import TalkToStrangerModule and provide NPool configs, in the example below is created a single module just to provide these module and it's configs:

import { CommonModule } from '@angular/common';
import { NgModule } from '@angular/core';
import { OmegleNPoolOpts } from './omegle.npool-opts';
import { POOL_OPTIONS_TOKEN, TalkToStrangerModule } from '@belomonte/ngx-parody-api';

@NgModule({
  imports: [
    CommonModule,
    TalkToStrangerModule
  ],
  providers: [
    {
      provide: POOL_OPTIONS_TOKEN,
      useClass: OmegleNPoolOpts
    }
  ],
  exports: [
    TalkToStrangerModule
  ]
})
export class OmegleModule { }
@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AppRoutingModule,

    // [...]
    OmegleModule
    // [...]
  ],
  bootstrap: [
    AppComponent
  ]
})
export class AppModule { }

In the example, the OmegleNPoolOpts service is the implementation of NPoolOpts<?> interface from @nostrify/nostrify, as you can read in nostrify docs, this implementation is required to routing events to correct relay and to read from desired relay. @belomonte/nostr-ngx will bring an overridable implementation for this, but here is an example of how it was implemented in omeglestr:

@Injectable()
export class OmegleNPoolOpts implements NPoolOpts<NRelay1> {

  constructor(
    //  in this example this is a custom service in the application that centralize user custom relay configs
    private relayConfigService: RelayConfigService
  ) { }
  
  open(url: string): NRelay1 {
    return new NRelay1(url);
  }

  async reqRouter(filters: NostrFilter[]): Promise<Map<string, NostrFilter[]>> {
    const toupleList: Array<[string, NostrFilter[]]> = [];
    this.relayConfigService
      .getConfig()
      .forEach(relay => toupleList.push([relay, filters]));

    return new Map(toupleList);
  }

  async eventRouter(): Promise<string[]> {
    return this.relayConfigService.getConfig();
  }
}

RelayConfigService is a custom service from omeglestr that read user choosen relay, you can copy this approuch from omeglestr, can set the relays hardcoded or can create a custom service.

Find Stranger

After you configure your app relays, to find a stranger you must inject the service FindStrangerService as the example below:

import { FindStrangerParody } from '@belomonte/ngx-parody-api';

// [...]
export class SearchStrangerComponent {

  //  by executing controller.abort() the search for stranger will
  //  be stopped, this can be used to allow user cancel search request
  controller = new AbortController();

  // [...]

  constructor(
    private findStrangerParody: FindStrangerParody
  ) { }

  // [...]

  onClickSearchStranger(): void {
    const stranger = await this.findStrangerParody
      .searchStranger({
        signal: this.controller,
        searchTags: [ 'omegle' ], // will search for users with wannachat status indexed with #omegle
        userTags: [ 'omegle' ] // will include in your wannachat status a tag #omegle to index it to searching strangers
      });
  }

  abortSearchStranger(): void {
    this.controller.abort();
  }

  // [...]

}

Status and messages

import { FindStrangerParody, NostrPublicUser, TalkToStrangerParody } from '@belomonte/ngx-parody-api';

// [...]
export class ChatingComponent implements OnDestroy, OnInit {
  
  subscriptions = new Subscription();
  strangerIsTyping = false;
  stranger: NostrPublicUser | null = null;

  messages: Array<{ pubkey: string, content: string, created_at: number }> = [];

  readonly typingTimeoutAmount = 2_000;
  typingTimeoutId = 0;

  // [...]
  constructor(
    private talkToStrangerParody: TalkToStrangerParody,
    private findStrangerParody: FindStrangerParody
  ) { }
  // [...]

  ngOnInit(): void {
    this.subscriptions.add(this.talkToStrangerParody
      .listenMessages(stranger)
      .subscribe({
        next: event => {
          this.talkToStrangerParody
            .openEncryptedDirectMessage(stranger, event)
            .then(content => {
              const { pubkey, created_at } = event;
              this.messages.push({ pubkey, content, created_at });
            });
        }
      }));

    this.subscriptions.add(this.talkToStrangerParody
      .listenStrangerStatus(stranger)
      .subscribe({
        next: event => {
          this.strangerIsTyping = event.content === 'typing';

          //  when stranger emits disconnect status, your session will
          //  automatically emit disconnect status too, so call .endSession
          //  is not needed, but keeps needed to clean component data
          if (event.content === 'disconnect') {
            this.cleanSession();
          }
        }
      }));
  }

  ngOnDestroy(): void {
    this.subscriptions.unsubscribe();
  }

  //  [...]
  //  send message to stranger
  async sendMessage(stranger: NostrPublicUser, message: string): Promise<void> {
    const typingPromise = this.talkToStrangerParody.isTyping();
    const messagePromise = this.talkToStrangerParody.sendMessage(stranger, message);
    await Promise.all([typingPromise, messagePromise]);
  }

  //  update typing status, must be bind into keydown event of textarea
  onTyping(): void {
    if (!this.typingTimeoutId) {
      this.talkToStrangerParody.isTyping();
    }

    clearTimeout(this.typingTimeoutId);
    this.typingTimeoutId = Number(setTimeout(() => {
      this.talkToStrangerParody.stopTyping();
      this.qtypingTimeoutId = 0;
    }, this.typingTimeoutAmount));
  }

  //  clean component data when user or partner disconnect
  cleanSession(): void {
    this.subscriptions.unsubscribe();
    this.subscriptions = new Subscription();
    this.strangerIsTyping = false;
    this.stranger = null;
  }

  //  called that when user wanna disconnect
  endSession(): Promise<void> {
    return this.findStrangerParody
      .endSession()
      .then(() => this.cleanSession());
  }
}